cp.apple.compressor.md

docs » cp.apple.compressor

---

Represents the Compressor application, providing functions that allow different tasks to be accomplished.

API Overview

• Constants - Useful values which cannot be changed
• ALLOWED_IMPORT_ALL_EXTENSIONS
• ALLOWED_IMPORT_AUDIO_EXTENSIONS
• ALLOWED_IMPORT_IMAGE_EXTENSIONS
• ALLOWED_IMPORT_VIDEO_EXTENSIONS
• BUNDLE_ID
• Fields - Variables which can only be accessed from an object returned by a constructor
• isFrontmost
• isInstalled
• isRunning
• isShowing
• Methods - API calls which can only be made on an object returned by a constructor
• application
• getBundleID
• getVersion
• hide
• launch
• path
• quit
• restart
• show

API Documentation

Constants

ALLOWED_IMPORT_ALL_EXTENSIONS

Signature	cp.apple.compressor.ALLOWED_IMPORT_ALL_EXTENSIONS
Type	Constant
Description	Table of all file extensions Final Cut Pro can import.

ALLOWED_IMPORT_AUDIO_EXTENSIONS

Signature	cp.apple.compressor.ALLOWED_IMPORT_AUDIO_EXTENSIONS
Type	Constant
Description	Table of audio file extensions Final Cut Pro can import.

ALLOWED_IMPORT_IMAGE_EXTENSIONS

Signature	cp.apple.compressor.ALLOWED_IMPORT_IMAGE_EXTENSIONS
Type	Constant
Description	Table of image file extensions Final Cut Pro can import.

ALLOWED_IMPORT_VIDEO_EXTENSIONS

Signature	cp.apple.compressor.ALLOWED_IMPORT_VIDEO_EXTENSIONS
Type	Constant
Description	Table of video file extensions Final Cut Pro can import.

BUNDLE_ID

Signature	cp.apple.compressor.BUNDLE_ID
Type	Constant
Description	Compressor's Bundle ID

Fields

isFrontmost

Signature	cp.apple.compressor.isFrontmost <cp.prop: boolean; read-only>
Type	Field
Description	Is Compressor Frontmost?

isInstalled

Signature	cp.apple.compressor.isInstalled <cp.prop: boolean; read-only>
Type	Field
Description	Is a supported version of Compressor Installed?

isRunning

Signature	cp.apple.compressor.isRunning <cp.prop: boolean; read-only>
Type	Field
Description	Is the app is running?

isShowing

Signature	cp.apple.compressor.isShowing <cp.prop: boolean; read-only>
Type	Field
Description	Is Compressor Showing?

Methods

application

Signature	cp.apple.compressor:application() -> hs.application
Type	Method
Description	Returns the hs.application for Compressor.
Parameters	None
Returns	The hs.application, or nil if the application is not installed.

getBundleID

Signature	cp.apple.compressor:getBundleID() -> string
Type	Method
Description	Returns the Compressor Bundle ID
Parameters	None
Returns	A string of the Compressor Bundle ID

getVersion

| Signature | cp.apple.compressor:getVersion() -> string | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Version of Compressor | | Parameters |

• None

| | Returns |

• Version as string or nil if an error occurred

| | Notes |

• If Compressor is running it will get the version of the active Compressor application, otherwise, it will use hs.application.infoForBundleID() to find the version.

|

hide

Signature	cp.apple.compressor:hide() -> cp.apple.compressor object
Type	Method
Description	Hides Compressor
Parameters	None
Returns	An cp.apple.compressor object otherwise nil

launch

Signature	cp.apple.compressor:launch() -> boolean
Type	Method
Description	Launches Compressor, or brings it to the front if it was already running.
Parameters	None
Returns	true if Compressor was either launched or focused, otherwise false (e.g. if Compressor doesn't exist)

path

Signature	cp.apple.compressor:path() -> string or nil
Type	Method
Description	Path to Compressor Application
Parameters	None
Returns	A string containing Compressor's filesystem path, or nil if the bundle identifier could not be located

quit

Signature	cp.apple.compressor:quit() -> cp.apple.compressor object
Type	Method
Description	Quits Compressor
Parameters	None
Returns	An cp.apple.compressor object otherwise nil

restart

Signature	cp.apple.compressor:restart() -> boolean
Type	Method
Description	Restart the application.
Parameters	None
Returns	true if the application was running and restarted successfully.

show

Signature	cp.apple.compressor:show() -> cp.apple.compressor object
Type	Method
Description	Activate Compressor
Parameters	None
Returns	An cp.apple.compressor object otherwise nil