compressor

Last updated 8 months ago

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

Submodules

API Overview

API Documentation

Constants

Signature

cp.apple.compressor.ALLOWED_IMPORT_ALL_EXTENSIONS

Type

Constant

Description

Table of all file extensions Final Cut Pro can import.

Signature

cp.apple.compressor.ALLOWED_IMPORT_AUDIO_EXTENSIONS

Type

Constant

Description

Table of audio file extensions Final Cut Pro can import.

Signature

cp.apple.compressor.ALLOWED_IMPORT_IMAGE_EXTENSIONS

Type

Constant

Description

Table of image file extensions Final Cut Pro can import.

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

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

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.

restart

Signature

cp.apple.compressor:restart([waitSeconds]) -> self

Type

Method

Description

Restart the application.

Parameters

waitSeconds - if provided, we will wait for up to the specified seconds for the restart to complete before returning.

Returns

true if the application was running and restarted successfully.

show

Signature

cp.apple.compressor:show() -> self

Type

Method

Description

Activate Compressor

Parameters

None

Returns

The compressor instance.