cp.apple.compressor.md

docs » cp.apple.compressor

---

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

Submodules

• cp.apple.compressor.app

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
• EARLIEST_SUPPORTED_VERSION
• Methods - API calls which can only be made on an object returned by a constructor
• bundleID
• doRestart
• hide
• launch
• notifier
• path
• quit
• 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

EARLIEST_SUPPORTED_VERSION

Signature	cp.apple.compressor.EARLIEST_SUPPORTED_VERSION <semver>
Type	Constant
Description	The earliest version this API supports.

Methods

bundleID

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

doRestart

Signature	cp.apple.compressor:doRestart() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will restart the application.
Parameters	None
Returns	true if the application was running and restarted successfully.

hide

Signature	cp.apple.compressor:hide() -> self
Type	Method
Description	Hides Compressor
Parameters	None
Returns	The compressor instance.

launch

Signature	cp.apple.compressor:launch([waitSeconds]) -> self
Type	Method
Description	Launches Compressor, or brings it to the front if it was already running.
Parameters	waitSeconds - if provided, we will wait for up to the specified seconds for the launch to complete.
Returns	true if Compressor was either launched or focused, otherwise false (e.g. if Compressor doesn't exist)

notifier

Signature	cp.apple.compressor:notifier() -> cp.ui.notifier
Type	Method
Description	Returns a notifier that is tracking the application UI element. It has already been started.
Parameters	None
Returns	The notifier.

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([waitSeconds]) -> self
Type	Method
Description	Quits Compressor
Parameters	waitSeconds - if provided, we will wait for the specified time for the quit to complete before returning.
Returns	The compressor instance.

show

Signature	cp.apple.compressor:show() -> self
Type	Method
Description	Activate Compressor
Parameters	None
Returns	The compressor instance.