#cp.apple.compressor

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

#Submodules

#API Overview

Constants - Useful values which cannot be changed

Methods - API calls which can only be made on an object returned by a constructor

#API Documentation

#Constants

Signaturecp.apple.compressor.ALLOWED_IMPORT_ALL_EXTENSIONS
TypeConstant
DescriptionTable of all file extensions Final Cut Pro can import.
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 38
Signaturecp.apple.compressor.ALLOWED_IMPORT_AUDIO_EXTENSIONS
TypeConstant
DescriptionTable of audio file extensions Final Cut Pro can import.
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 28
Signaturecp.apple.compressor.ALLOWED_IMPORT_IMAGE_EXTENSIONS
TypeConstant
DescriptionTable of image file extensions Final Cut Pro can import.
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 33
Signaturecp.apple.compressor.ALLOWED_IMPORT_VIDEO_EXTENSIONS
TypeConstant
DescriptionTable of video file extensions Final Cut Pro can import.
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 23
Signaturecp.apple.compressor.BUNDLE_ID
TypeConstant
DescriptionCompressor's Bundle ID
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 18
Signaturecp.apple.compressor.EARLIEST_SUPPORTED_VERSION <semver>
TypeConstant
DescriptionThe earliest version this API supports.
NotesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 43

#Methods

Signaturecp.apple.compressor:bundleID() -> string
TypeMethod
DescriptionReturns the Compressor Bundle ID
Parameters
  • None
Returns
  • A string of the Compressor Bundle ID
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 125
Signaturecp.apple.compressor:doRestart() -> cp.rx.go.Statement
TypeMethod
DescriptionReturns a Statement that will restart the application.
Parameters
  • None
Returns
  • true if the application was running and restarted successfully.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 170
Signaturecp.apple.compressor:hide() -> self
TypeMethod
DescriptionHides Compressor
Parameters
  • None
Returns
  • The compressor instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 201
Signaturecp.apple.compressor:launch([waitSeconds]) -> self
TypeMethod
DescriptionLaunches 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)
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 151
Signaturecp.apple.compressor:notifier() -> cp.ui.notifier
TypeMethod
DescriptionReturns a notifier that is tracking the application UI element. It has already been started.
Parameters
  • None
Returns
  • The notifier.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 138
Signaturecp.apple.compressor:path() -> string or nil
TypeMethod
DescriptionPath to Compressor Application
Parameters
  • None
Returns
  • A string containing Compressor's filesystem path, or nil if the bundle identifier could not be located
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 237
Signaturecp.apple.compressor:quit([waitSeconds]) -> self
TypeMethod
DescriptionQuits Compressor
Parameters
  • waitSeconds - if provided, we will wait for the specified time for the quit to complete before returning.
Returns
  • The compressor instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 219
Signaturecp.apple.compressor:show() -> self
TypeMethod
DescriptionActivate Compressor
Parameters
  • None
Returns
  • The compressor instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/compressor/init.lua line 183

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.