# cp.apple.finalcutpro Represents the Final Cut Pro application, providing functions that allow different tasks to be accomplished. Generally, you will `require` the `cp.apple.finalcutpro` module to import it, like so: ```lua local fcp = require "cp.apple.finalcutpro" ``` Then, there are the `UpperCase` files, which represent the application itself: * `MenuBar` - The main menu bar. * `prefs/PreferencesWindow` - The preferences window. * etc... The `fcp` variable is the root application. It has functions which allow you to perform tasks or access parts of the UI. For example, to open the `Preferences` window, you can do this: ```lua fcp.preferencesWindow:show() ``` In general, as long as Final Cut Pro is running, actions can be performed directly, and the API will perform the required operations to achieve it. For example, to toggle the 'Create Optimized Media' checkbox in the 'Import' section of the 'Preferences' window, you can simply do this: ```lua fcp.preferencesWindow.importPanel:toggleCreateOptimizedMedia() ``` The API will automatically open the `Preferences` window, navigate to the 'Import' panel and toggle the checkbox. The `UpperCase` classes also have a variety of `UI` methods. These will return the `axuielement` for the relevant GUI element, if it is accessible. If not, it will return `nil`. These allow direct interaction with the GUI if necessary. It's most useful when adding new functions to `UpperCase` files for a particular element. This can also be used to 'wait' for an element to be visible before performing a task. For example, if you need to wait for the `Preferences` window to finish loading before doing something else, you can do this with the [just](cp.just.md) library: ```lua local just = require "cp.just" local prefsWindow = fcp.preferencesWindow local prefsUI = just.doUntil(function() return prefsWindow:UI() end) if prefsUI then -- it's open! else -- it's closed! end ``` By using the `just` library, we can do a loop waiting until the function returns a result that will give up after a certain time period (10 seconds by default). Of course, we have a specific support function for that already, so you could do this instead: ```lua if fcp.preferencesWindow:isShowing() then -- it's open! else -- it's closed! end ``` **Delegates to:** [app](cp.apple.finalcutpro.app.md), [menu](cp.app.menu.md) Notes: All values/methods/props from delegates can be accessed directly from the `cp.apple.finalcutpro` instance. For example: ```lua fcp.app:UI() == fcp:UI() -- the same `cp.prop` result. ``` --- ## Submodules * [cp.apple.finalcutpro.app](cp.apple.finalcutpro.app.md) * [cp.apple.finalcutpro.browser](cp.apple.finalcutpro.browser.md) * [cp.apple.finalcutpro.cmd](cp.apple.finalcutpro.cmd.md) * [cp.apple.finalcutpro.content](cp.apple.finalcutpro.content.md) * [cp.apple.finalcutpro.export](cp.apple.finalcutpro.export.md) * [cp.apple.finalcutpro.import](cp.apple.finalcutpro.import.md) * [cp.apple.finalcutpro.inspector](cp.apple.finalcutpro.inspector.md) * [cp.apple.finalcutpro.main](cp.apple.finalcutpro.main.md) * [cp.apple.finalcutpro.menu](cp.apple.finalcutpro.menu.md) * [cp.apple.finalcutpro.plugins](cp.apple.finalcutpro.plugins.md) * [cp.apple.finalcutpro.prefs](cp.apple.finalcutpro.prefs.md) * [cp.apple.finalcutpro.strings](cp.apple.finalcutpro.strings.md) * [cp.apple.finalcutpro.timeline](cp.apple.finalcutpro.timeline.md) * [cp.apple.finalcutpro.viewer](cp.apple.finalcutpro.viewer.md) * [cp.apple.finalcutpro.workflowextensions](cp.apple.finalcutpro.workflowextensions.md) --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [ALLOWED_IMPORT_AUDIO_EXTENSIONS](#allowed_import_audio_extensions) * [ALLOWED_IMPORT_EXTENSIONS](#allowed_import_extensions) * [ALLOWED_IMPORT_IMAGE_EXTENSIONS](#allowed_import_image_extensions) * [ALLOWED_IMPORT_VIDEO_EXTENSIONS](#allowed_import_video_extensions) * [EARLIEST_SUPPORTED_VERSION](#earliest_supported_version) * [EVENT_DESCRIPTION_PATH](#event_description_path) * [FLEXO_LANGUAGES](#flexo_languages) * [PASTEBOARD_UTI](#pasteboard_uti) * [preferences](#preferences) * [WORKSPACES_PATH](#workspaces_path) **Variables** - _Configurable values_ * [activeCommandSet](#activecommandset) * [customWorkspaces](#customworkspaces) * [openAndSavePanelDefaultPath](#openandsavepaneldefaultpath) * [selectedWorkspace](#selectedworkspace) **Functions** - _API calls offered directly by the extension_ * [commandSet](#commandset) * [matches](#matches) * [matches](#matches) * [userCommandSetPath](#usercommandsetpath) * [workflowExtensionNames](#workflowextensionnames) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [Color](#color) * [TranscodeMedia](#transcodemedia) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [activeCommandSetPath](#activecommandsetpath) * [alert](#alert) * [audioEnhancements](#audioenhancements) * [audioLanes](#audiolanes) * [audioMeters](#audiometers) * [backgroundTasksDialog](#backgroundtasksdialog) * [browser](#browser) * [changePosition](#changeposition) * [color](#color) * [colorBoard](#colorboard) * [colorCorrection](#colorcorrection) * [commandDescriptions](#commanddescriptions) * [commandEditor](#commandeditor) * [commandNames](#commandnames) * [commandPostWorkflowExtension](#commandpostworkflowextension) * [contentUI](#contentui) * [contentUI](#contentui) * [deselectAll](#deselectall) * [effects](#effects) * [effects](#effects) * [eventViewer](#eventviewer) * [exportDialog](#exportdialog) * [findAndReplaceTitleText](#findandreplacetitletext) * [fullScreenPlayer](#fullscreenplayer) * [generators](#generators) * [inspector](#inspector) * [inspectorUnits](#inspectorunits) * [isAudioScrubbingEnabled](#isaudioscrubbingenabled) * [isFrontmost](#isfrontmost) * [isInstalled](#isinstalled) * [isModalDialogOpen](#ismodaldialogopen) * [isPlaying](#isplaying) * [isPlaying](#isplaying) * [isRunning](#isrunning) * [isShowing](#isshowing) * [isSkimmingEnabled](#isskimmingenabled) * [isSupported](#issupported) * [isUnsupported](#isunsupported) * [keywordEditor](#keywordeditor) * [libraries](#libraries) * [media](#media) * [mediaImport](#mediaimport) * [pan](#pan) * [playButton](#playbutton) * [playFullScreen](#playfullscreen) * [playImage](#playimage) * [preferencesWindow](#preferenceswindow) * [preset](#preset) * [primaryWindow](#primarywindow) * [resetDialogWarnings](#resetdialogwarnings) * [secondaryWindow](#secondarywindow) * [textArea](#textarea) * [textLayerLeft](#textlayerleft) * [textLayerRight](#textlayerright) * [timecodeField](#timecodefield) * [timeDisplay](#timedisplay) * [timeline](#timeline) * [toolbar](#toolbar) * [transcodeMedia](#transcodemedia) * [transitions](#transitions) * [UI](#ui) * [validateAudioUnits](#validateaudiounits) * [viewer](#viewer) * [volume](#volume) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [activeLibraryPaths](#activelibrarypaths) * [closeLibrary](#closelibrary) * [defaultCommandSetPath](#defaultcommandsetpath) * [doShortcut](#doshortcut) * [getCommandShortcuts](#getcommandshortcuts) * [getPath](#getpath) * [importXML](#importxml) * [keysWithString](#keyswithstring) * [openLibrary](#openlibrary) * [plugins](#plugins) * [recentLibraryNames](#recentlibrarynames) * [recentLibraryPaths](#recentlibrarypaths) * [scanPlugins](#scanplugins) * [selectLibrary](#selectlibrary) * [string](#string) * [userCommandSets](#usercommandsets) --- ## API Documentation #### Constants ### [ALLOWED_IMPORT_AUDIO_EXTENSIONS](#allowed_import_audio_extensions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.ALLOWED_IMPORT_AUDIO_EXTENSIONS -> table` | | **Type** | Constant | | **Description** | Table of audio file extensions Final Cut Pro can import. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 236](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L236) | --- ### [ALLOWED_IMPORT_EXTENSIONS](#allowed_import_extensions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.ALLOWED_IMPORT_EXTENSIONS -> table` | | **Type** | Constant | | **Description** | Table of all file extensions Final Cut Pro can import. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 246](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L246) | --- ### [ALLOWED_IMPORT_IMAGE_EXTENSIONS](#allowed_import_image_extensions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.ALLOWED_IMPORT_IMAGE_EXTENSIONS -> table` | | **Type** | Constant | | **Description** | Table of image file extensions Final Cut Pro can import. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 241](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L241) | --- ### [ALLOWED_IMPORT_VIDEO_EXTENSIONS](#allowed_import_video_extensions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.ALLOWED_IMPORT_VIDEO_EXTENSIONS -> table` | | **Type** | Constant | | **Description** | Table of video file extensions Final Cut Pro can import. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 231](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L231) | --- ### [EARLIEST_SUPPORTED_VERSION](#earliest_supported_version) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.EARLIEST_SUPPORTED_VERSION -> string` | | **Type** | Constant | | **Description** | The earliest version of Final Cut Pro supported by this module. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 206](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L206) | --- ### [EVENT_DESCRIPTION_PATH](#event_description_path) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.EVENT_DESCRIPTION_PATH -> string` | | **Type** | Constant | | **Description** | The Event Description Path. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 221](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L221) | --- ### [FLEXO_LANGUAGES](#flexo_languages) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.FLEXO_LANGUAGES -> table` | | **Type** | Constant | | **Description** | Table of Final Cut Pro's supported Languages for the Flexo Framework | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 226](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L226) | --- ### [PASTEBOARD_UTI](#pasteboard_uti) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.PASTEBOARD_UTI -> string` | | **Type** | Constant | | **Description** | Final Cut Pro's Pasteboard UTI | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 211](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L211) | --- ### [preferences](#preferences) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.preferences ` | | **Type** | Constant | | **Description** | The `cp.app.prefs` for Final Cut Pro. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 161](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L161) | --- ### [WORKSPACES_PATH](#workspaces_path) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.WORKSPACES_PATH -> string` | | **Type** | Constant | | **Description** | The path to the custom workspaces folder. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 216](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L216) | --- #### Variables ### [activeCommandSet](#activecommandset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.activeCommandSet ` | | **Type** | Variable | | **Description** | Contins the 'Active Command Set' as a `table`. The result is cached, but | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1058](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1058) | --- ### [customWorkspaces](#customworkspaces) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:customWorkspaces ` | | **Type** | Variable | | **Description** | A table containing the display names of all the user created custom workspaces. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 616](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L616) | --- ### [openAndSavePanelDefaultPath](#openandsavepaneldefaultpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:openAndSavePanelDefaultPath ` | | **Type** | Variable | | **Description** | A string containing the default open/save panel path. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 943](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L943) | --- ### [selectedWorkspace](#selectedworkspace) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.selectedWorkspace ` | | **Type** | Variable | | **Description** | The currently selected workspace name. The result is cached, but updated | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 584](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L584) | --- #### Functions ### [commandSet](#commandset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.commandSet(path) -> string` | | **Type** | Function | | **Description** | Gets the Command Set at the specified path as a table. | | **Parameters** |
  • `path` - The path to the Command Set.
| | **Returns** |
  • The Command Set as a table, or `nil` if there was a problem.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1040](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1040) | --- ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.CommandEditor.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks to see if an element matches what we think it should be. | | **Parameters** |
  • element - An `axuielementObject` to check.
| | **Returns** |
  • `true` if matches otherwise `false`
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 30](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua#L30) | --- ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.TranscodeMedia.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks if the element is an `TranscodeMedia` instance. | | **Parameters** |
  • element - The `axuielement` to check.
| | **Returns** |
  • `true` if it matches the pattern for a `Viewer` `TranscodeMedia`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/TranscodeMedia.lua line 21](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/TranscodeMedia.lua#L21) | --- ### [userCommandSetPath](#usercommandsetpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.userCommandSetPath() -> string or nil` | | **Type** | Function | | **Description** | Gets the path where User Command Set files are stored. | | **Parameters** |
  • None
| | **Returns** |
  • A path as a string or `nil` if the folder doesn't exist.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 984](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L984) | --- ### [workflowExtensionNames](#workflowextensionnames) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.workflowExtensionNames() -> table` | | **Type** | Function | | **Description** | Gets the names of all the installed Workflow Extensions. | | **Parameters** |
  • None
| | **Returns** |
  • A table of Workflow Extension names
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 645](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L645) | --- #### Constructors ### [Color](#color) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.Color(app) -> Color` | | **Type** | Constructor | | **Description** | Creates a new `Color` instance. | | **Parameters** |
  • app - The Final Cut Pro app instance.
| | **Returns** |
  • The new `Color`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/color/Tracker.lua line 34](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/color/Tracker.lua#L34) | --- ### [TranscodeMedia](#transcodemedia) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.TranscodeMedia(viewer)` | | **Type** | Constructor | | **Description** | Creates a new `TranscodeMedia` instance. | | **Parameters** |
  • parent - The parent object.
| | **Returns** |
  • The new `TranscodeMedia`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/TranscodeMedia.lua line 42](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/TranscodeMedia.lua#L42) | --- #### Fields ### [activeCommandSetPath](#activecommandsetpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.activeCommandSetPath ` | | **Type** | Field | | **Description** | Gets the 'Active Command Set' value from the Final Cut Pro preferences | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1033](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1033) | --- ### [alert](#alert) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.alert ` | | **Type** | Field | | **Description** | Provides basic access to any 'alert' dialog windows in the app. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 907](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L907) | --- ### [audioEnhancements](#audioenhancements) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.VideoInspector.audioEnhancements ` | | **Type** | Field | | **Description** | Audio Enhancements | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua line 139](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua#L139) | --- ### [audioLanes](#audiolanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.audioLanes ` | | **Type** | Field | | **Description** | Indicates if audio lanes are currently showing. May be set to ensure it is showing or hidden. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 103](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L103) | --- ### [audioMeters](#audiometers) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.audioMeters ` | | **Type** | Field | | **Description** | Audio Meters button. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 93](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L93) | --- ### [backgroundTasksDialog](#backgroundtasksdialog) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.backgroundTasksDialog ` | | **Type** | Field | | **Description** | The [BackgroundTasksDialog](cp.apple.finalcutpro.main.BackgroundTasksDialog.md) dialog window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 790](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L790) | --- ### [browser](#browser) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.browser ` | | **Type** | Field | | **Description** | The [Browser](cp.apple.finalcutpro.main.Browser.md) instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 844](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L844) | --- ### [changePosition](#changeposition) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.changePosition ` | | **Type** | Field | | **Description** | Change Position Button. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 236](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L236) | --- ### [color](#color) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.color ` | | **Type** | Field | | **Description** | The ColorInspector instance from the primary window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 900](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L900) | --- ### [colorBoard](#colorboard) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.colorBoard ` | | **Type** | Field | | **Description** | The ColorBoard instance from the primary window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 893](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L893) | --- ### [colorCorrection](#colorcorrection) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.presfs.GeneralPanel.colorCorrection ` | | **Type** | Field | | **Description** | The "Color Correction" `PopUpButton`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua line 116](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua#L116) | --- ### [commandDescriptions](#commanddescriptions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.commandDescriptions ` | | **Type** | Field | | **Description** | The `table` of all available command descriptions, with keys mapped to human-readable descriptions in the current locale. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1135](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1135) | --- ### [commandEditor](#commandeditor) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.commandEditor ` | | **Type** | Field | | **Description** | The Final Cut Pro Command Editor | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 755](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L755) | --- ### [commandNames](#commandnames) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.commandNames ` | | **Type** | Field | | **Description** | The `table` of all available command names, with keys mapped to human-readable names in the current locale. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1114](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1114) | --- ### [commandPostWorkflowExtension](#commandpostworkflowextension) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.commandPostWorkflowExtension ` | | **Type** | Field | | **Description** | The CommandPost Workflow Extension window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 714](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L714) | --- ### [contentUI](#contentui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.contentUI ` | | **Type** | Field | | **Description** | The `axuielement` containing the properties rows, if available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 438](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L438) | --- ### [contentUI](#contentui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ShareInspector.contentUI ` | | **Type** | Field | | **Description** | The `axuielement` containing the properties rows, if available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/share/ShareInspector.lua line 105](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/share/ShareInspector.lua#L105) | --- ### [deselectAll](#deselectall) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.deselectAll ` | | **Type** | Field | | **Description** | The left text layer arrow at the bottom of the Inspector. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 473](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L473) | --- ### [effects](#effects) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.effects ` | | **Type** | Field | | **Description** | The EffectsBrowser instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 872](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L872) | --- ### [effects](#effects) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.VideoInspector.effects ` | | **Type** | Field | | **Description** | Effects | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua line 153](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua#L153) | --- ### [eventViewer](#eventviewer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.eventViewer ` | | **Type** | Field | | **Description** | The Event [Viewer](cp.apple.finalcutpro.viewer.Viewer.md) instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 837](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L837) | --- ### [exportDialog](#exportdialog) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.exportDialog ` | | **Type** | Field | | **Description** | The Final Cut Pro Export Dialog Box | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 776](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L776) | --- ### [findAndReplaceTitleText](#findandreplacetitletext) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.findAndReplaceTitleText ` | | **Type** | Field | | **Description** | The [FindAndReplaceTitleText](cp.apple.finalcutpro.main.FindAndReplaceTitleText.md) dialog window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 783](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L783) | --- ### [fullScreenPlayer](#fullscreenplayer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.fullScreenPlayer ` | | **Type** | Field | | **Description** | Returns the Final Cut Pro Full Screen Window (usually triggered by Cmd+Shift+F) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 748](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L748) | --- ### [generators](#generators) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.generators ` | | **Type** | Field | | **Description** | The GeneratorsBrowser instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 865](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L865) | --- ### [inspector](#inspector) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector ` | | **Type** | Field | | **Description** | The [Inspector](cp.apple.finalcutpro.inspector.Inspector.md) instance from the primary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 886](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L886) | --- ### [inspectorUnits](#inspectorunits) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.presfs.GeneralPanel.inspectorUnits ` | | **Type** | Field | | **Description** | The "Inspector Units" `PopUpButton`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua line 125](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua#L125) | --- ### [isAudioScrubbingEnabled](#isaudioscrubbingenabled) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isAudioScrubbingEnabled ` | | **Type** | Field | | **Description** | Returns `true` if the audio scrubbing is enabled for the application. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1163](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1163) | --- ### [isFrontmost](#isfrontmost) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:isFrontmost ` | | **Type** | Field | | **Description** | Is Final Cut Pro Frontmost? | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 288](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L288) | --- ### [isInstalled](#isinstalled) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isInstalled ` | | **Type** | Field | | **Description** | Is any version of Final Cut Pro Installed? | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 281](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L281) | --- ### [isModalDialogOpen](#ismodaldialogopen) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:isModalDialogOpen ` | | **Type** | Field | | **Description** | Is a modal dialog currently open? | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 295](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L295) | --- ### [isPlaying](#isplaying) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.ControlBar.isPlaying ` | | **Type** | Field | | **Description** | The 'playing' status of the viewer. If true, it is playing, if not it is paused. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 254](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L254) | --- ### [isPlaying](#isplaying) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.Viewer.isPlaying ` | | **Type** | Field | | **Description** | The 'playing' status of the viewer. If true, it is playing, if not it is paused. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 336](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L336) | --- ### [isRunning](#isrunning) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isRunning ` | | **Type** | Field | | **Description** | Is Final Cut Pro Running? | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 263](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L263) | --- ### [isShowing](#isshowing) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isShowing ` | | **Type** | Field | | **Description** | Is Final Cut visible on screen? | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 274](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L274) | --- ### [isSkimmingEnabled](#isskimmingenabled) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isSkimmingEnabled ` | | **Type** | Field | | **Description** | Returns `true` if the skimming playhead is enabled for the application. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1156](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1156) | --- ### [isSupported](#issupported) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isSupported ` | | **Type** | Field | | **Description** | Is a supported version of Final Cut Pro installed? | | **Notes** |
  • Supported version refers to any version of Final Cut Pro equal or higher to `cp.apple.finalcutpro.EARLIEST_SUPPORTED_VERSION`
| | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 302](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L302) | --- ### [isUnsupported](#isunsupported) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.isUnsupported ` | | **Type** | Field | | **Description** | Is an unsupported version of Final Cut Pro installed? | | **Notes** |
  • Supported version refers to any version of Final Cut Pro equal or higher to cp.apple.finalcutpro.EARLIEST_SUPPORTED_VERSION
| | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 315](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L315) | --- ### [keywordEditor](#keywordeditor) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.keywordEditor ` | | **Type** | Field | | **Description** | The Final Cut Pro Keyword Editor | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 762](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L762) | --- ### [libraries](#libraries) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.libraries ` | | **Type** | Field | | **Description** | The [LibrariesBrowser](cp.apple.finalcutpro.main.LibrariesBrowser.md) instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 851](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L851) | --- ### [media](#media) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.media ` | | **Type** | Field | | **Description** | The MediaBrowser instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 858](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L858) | --- ### [mediaImport](#mediaimport) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.mediaImport ` | | **Type** | Field | | **Description** | The Final Cut Pro Media Import Window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 769](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L769) | --- ### [pan](#pan) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.VideoInspector.pan ` | | **Type** | Field | | **Description** | Pan | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua line 146](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua#L146) | --- ### [playButton](#playbutton) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.playButton ` | | **Type** | Field | | **Description** | Play Button. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 245](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L245) | --- ### [playFullScreen](#playfullscreen) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.playFullScreen ` | | **Type** | Field | | **Description** | Play Full Screen Button. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 84](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L84) | --- ### [playImage](#playimage) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.playImage ` | | **Type** | Field | | **Description** | Play Image. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 279](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L279) | --- ### [preferencesWindow](#preferenceswindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.preferencesWindow ` | | **Type** | Field | | **Description** | The Final Cut Pro Preferences Window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 727](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L727) | --- ### [preset](#preset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.preset ` | | **Type** | Field | | **Description** | The preset popup found at the top of the inspector. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 483](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L483) | --- ### [primaryWindow](#primarywindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.primaryWindow ` | | **Type** | Field | | **Description** | The Final Cut Pro Primary Window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 734](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L734) | --- ### [resetDialogWarnings](#resetdialogwarnings) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.presfs.GeneralPanel.resetDialogWarnings ` | | **Type** | Field | | **Description** | The "Reset Dialog warnings" `Button`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua line 98](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua#L98) | --- ### [secondaryWindow](#secondarywindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.secondaryWindow ` | | **Type** | Field | | **Description** | The Final Cut Pro Preferences Window | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 741](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L741) | --- ### [textArea](#textarea) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.textArea ` | | **Type** | Field | | **Description** | The Text Inspector main Text Area. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 493](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L493) | --- ### [textLayerLeft](#textlayerleft) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.textLayerLeft ` | | **Type** | Field | | **Description** | The left text layer arrow at the bottom of the Inspector. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 451](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L451) | --- ### [textLayerRight](#textlayerright) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.TextInspector.textLayerRight ` | | **Type** | Field | | **Description** | The left text layer arrow at the bottom of the Inspector. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua line 462](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/text/TextInspector.lua#L462) | --- ### [timecodeField](#timecodefield) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.timecodeField ` | | **Type** | Field | | **Description** | Timecode Field | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua line 102](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/ControlBar.lua#L102) | --- ### [timeDisplay](#timedisplay) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.presfs.GeneralPanel.timeDisplay ` | | **Type** | Field | | **Description** | The "Time Display" `PopUpButton`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua line 89](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua#L89) | --- ### [timeline](#timeline) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline ` | | **Type** | Field | | **Description** | The Timeline instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 823](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L823) | --- ### [toolbar](#toolbar) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.toolbar ` | | **Type** | Field | | **Description** | The Primary Toolbar - the toolbar at the top of the Primary Window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 816](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L816) | --- ### [transcodeMedia](#transcodemedia) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.transcodeMedia ` | | **Type** | Field | | **Description** | The [TranscodeMedia](cp.apple.finalcutpro.main.TranscodeMedia.md) sheet. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 803](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L803) | --- ### [transitions](#transitions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.transitions ` | | **Type** | Field | | **Description** | The Transitions `EffectsBrowser` instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 879](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L879) | --- ### [UI](#ui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.UI ` | | **Type** | Field | | **Description** | The Final Cut Pro `axuielement`, if available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 270](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L270) | --- ### [validateAudioUnits](#validateaudiounits) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.presfs.GeneralPanel.validateAudioUnits ` | | **Type** | Field | | **Description** | The "Validate Audio Units" `Button`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua line 107](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/prefs/GeneralPanel.lua#L107) | --- ### [viewer](#viewer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer ` | | **Type** | Field | | **Description** | The [Viewer](cp.apple.finalcutpro.viewer.Viewer.md) instance, whether it is in the primary or secondary window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 830](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L830) | --- ### [volume](#volume) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.VideoInspector.volume ` | | **Type** | Field | | **Description** | Volume | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua line 132](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/audio/AudioInspector.lua#L132) | --- #### Methods ### [activeLibraryPaths](#activelibrarypaths) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:activeLibraryPaths() -> table` | | **Type** | Method | | **Description** | Gets a table of all the active library paths. | | **Parameters** |
  • None
| | **Returns** |
  • A table containing any active library paths.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 400](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L400) | --- ### [closeLibrary](#closelibrary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:closeLibrary(title) -> boolean` | | **Type** | Method | | **Description** | Attempts to close a library with the specified `title`. | | **Parameters** |
  • title - The title of the FCP Library to close.
| | **Returns** |
  • `true` if successful, or `false` if not.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 505](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L505) | --- ### [defaultCommandSetPath](#defaultcommandsetpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:defaultCommandSetPath([locale]) -> string` | | **Type** | Method | | **Description** | Gets the path to the 'Default' Command Set. | | **Parameters** |
  • `locale` - The optional locale to use. Defaults to the [current locale](#currentLocale).
| | **Returns** |
  • The 'Default' Command Set path, or `nil` if an error occurred
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1019](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1019) | --- ### [doShortcut](#doshortcut) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:doShortcut(whichShortcut[, suppressPrompt]) -> Statement` | | **Type** | Method | | **Description** | Perform a Final Cut Pro Keyboard Shortcut | | **Parameters** |
  • whichShortcut - As per the Command Set name
  • suppressPrompt - If `true`, and no shortcut is found for the specified command, then no prompt will be shown and an error is thrown Defaults to `false`.
| | **Returns** |
  • A `Statement` that will perform the shortcut when executed.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1173](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1173) | --- ### [getCommandShortcuts](#getcommandshortcuts) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.getCommandShortcuts(id) -> table of hs.commands.shortcut` | | **Type** | Method | | **Description** | Finds a shortcut from the Active Command Set with the specified ID and returns a table of `hs.commands.shortcut`s for the specified command, or `nil` if it doesn't exist. | | **Parameters** |
  • id - The unique ID for the command.
| | **Returns** |
  • The array of shortcuts, or `nil` if no command exists with the specified `id`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 1088](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L1088) | --- ### [getPath](#getpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:getPath() -> string or nil` | | **Type** | Method | | **Description** | Path to Final Cut Pro Application | | **Parameters** |
  • None
| | **Returns** |
  • A string containing Final Cut Pro's filesystem path, or nil if Final Cut Pro's path could not be determined.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 357](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L357) | --- ### [importXML](#importxml) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:importXML(path) -> boolean` | | **Type** | Method | | **Description** | Imports an XML file into Final Cut Pro | | **Parameters** |
  • path = Path to XML File
| | **Returns** |
  • A boolean value indicating whether the AppleScript succeeded or not
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 920](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L920) | --- ### [keysWithString](#keyswithstring) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:keysWithString(string[, locale]) -> {string}` | | **Type** | Method | | **Description** | Looks up an application string and returns an array of keys that match. It will take into account current locale the app is running in, or use `locale` if provided. | | **Parameters** |
  • `key` - The key to look up.
  • `locale` - The locale (defaults to current FCPX locale).
| | **Returns** |
  • The array of keys with a matching string.
| | **Notes** |
  • This method may be very inefficient, since it has to search through every possible key/value pair to find matches. It is not recommended that this is used in production.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 340](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L340) | --- ### [openLibrary](#openlibrary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:openLibrary(path) -> boolean` | | **Type** | Method | | **Description** | Attempts to open a file at the specified absolute `path`. | | **Parameters** |
  • path - The path to the FCP Library to open.
| | **Returns** |
  • `true` if successful, or `false` if not.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 467](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L467) | --- ### [plugins](#plugins) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:plugins() -> cp.apple.finalcutpro.plugins` | | **Type** | Method | | **Description** | Returns the plugins manager for the app. | | **Parameters** |
  • None
| | **Returns** |
  • The plugins manager.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 552](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L552) | --- ### [recentLibraryNames](#recentlibrarynames) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:recentLibraryNames() -> table` | | **Type** | Method | | **Description** | Gets a table of all the recent library names (that are accessible). | | **Parameters** |
  • None
| | **Returns** |
  • A table containing any recent library names.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 446](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L446) | --- ### [recentLibraryPaths](#recentlibrarypaths) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:recentLibraryPaths() -> table` | | **Type** | Method | | **Description** | Gets a table of all the recent library paths (that are accessible). | | **Parameters** |
  • None
| | **Returns** |
  • A table containing any recent library paths.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 421](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L421) | --- ### [scanPlugins](#scanplugins) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:scanPlugins() -> table` | | **Type** | Method | | **Description** | Scan Final Cut Pro Plugins | | **Parameters** |
  • None
| | **Returns** |
  • A MenuBar object
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 565](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L565) | --- ### [selectLibrary](#selectlibrary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:selectLibrary(title) -> axuielement` | | **Type** | Method | | **Description** | Attempts to select an open library with the specified title. | | **Parameters** |
  • title - The title of the library to select.
| | **Returns** |
  • The library row `axuielement`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 492](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L492) | --- ### [string](#string) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:string(key[, locale[, quiet]]) -> string` | | **Type** | Method | | **Description** | Looks up an application string with the specified `key`. If no `locale` value is provided, the [current locale](#currentLocale) is used. | | **Parameters** |
  • `key` - The key to look up.
  • `locale` - The locale code to use. Defaults to the current locale.
  • `quiet` - Optional boolean, defaults to `false`. If `true`, no warnings are logged for missing keys.
| | **Returns** |
  • The requested string or `nil` if the application is not running.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 325](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L325) | --- ### [userCommandSets](#usercommandsets) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro:userCommandSets() -> table` | | **Type** | Method | | **Description** | Gets the names of all of the user command sets. | | **Parameters** |
  • None
| | **Returns** |
  • A table of user command sets as strings.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/init.lua line 997](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/init.lua#L997) | --- ---