# cp.blackmagic.resolve The Blackmagic DaVinci Resolve Extension. --- ## Submodules * [cp.blackmagic.resolve.app](cp.blackmagic.resolve.app.md) * [cp.blackmagic.resolve.color](cp.blackmagic.resolve.color.md) * [cp.blackmagic.resolve.main](cp.blackmagic.resolve.main.md) --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [EARLIEST_SUPPORTED_VERSION](#earliest_supported_version) * [preferences](#preferences) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [Color](#color) * [currentLocale](#currentlocale) * [isFrontmost](#isfrontmost) * [isInstalled](#isinstalled) * [isModalDialogOpen](#ismodaldialogopen) * [isRunning](#isrunning) * [isShowing](#isshowing) * [isSupported](#issupported) * [isUnsupported](#isunsupported) * [primaryWindow](#primarywindow) * [supportedLocales](#supportedlocales) * [UI](#ui) * [version](#version) * [versionString](#versionstring) * [windowsUI](#windowsui) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [bundleID](#bundleid) * [doHide](#dohide) * [doLaunch](#dolaunch) * [doQuit](#doquit) * [doRestart](#dorestart) * [doShow](#doshow) * [getPath](#getpath) * [hide](#hide) * [launch](#launch) * [notifier](#notifier) * [quit](#quit) * [show](#show) --- ## API Documentation #### Constants ### [EARLIEST_SUPPORTED_VERSION](#earliest_supported_version) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION ` | | **Type** | Constant | | **Description** | The earliest version this API supports. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 23](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L23) | --- ### [preferences](#preferences) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.preferences ` | | **Type** | Constant | | **Description** | The `cp.app.prefs` for DaVinci Resolve. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 35](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L35) | --- #### Fields ### [Color](#color) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.Color ` | | **Type** | Field | | **Description** | The Color Workspace. | | **Parameters** |
  • None
| | **Returns** |
  • the Browser
| | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 338](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L338) | --- ### [currentLocale](#currentlocale) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.currentLocale ` | | **Type** | Field | | **Description** | Gets and sets the current locale for FCPX. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 124](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L124) | --- ### [isFrontmost](#isfrontmost) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:isFrontmost ` | | **Type** | Field | | **Description** | Is DaVinci Resolve Frontmost? | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 90](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L90) | --- ### [isInstalled](#isinstalled) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.isInstalled ` | | **Type** | Field | | **Description** | Is any version of DaVinci Resolve Installed? | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 83](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L83) | --- ### [isModalDialogOpen](#ismodaldialogopen) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:isModalDialogOpen ` | | **Type** | Field | | **Description** | Is a modal dialog currently open? | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 97](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L97) | --- ### [isRunning](#isrunning) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.isRunning ` | | **Type** | Field | | **Description** | Is DaVinci Resolve Running? | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 55](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L55) | --- ### [isShowing](#isshowing) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.isShowing ` | | **Type** | Field | | **Description** | Is Final Cut visible on screen? | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 76](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L76) | --- ### [isSupported](#issupported) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.isSupported ` | | **Type** | Field | | **Description** | Is a supported version of DaVinci Resolve installed? | | **Notes** |
  • Supported version refers to any version of DaVinci Resolve equal or higher to `cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION`
| | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 104](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L104) | --- ### [isUnsupported](#isunsupported) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.isUnsupported ` | | **Type** | Field | | **Description** | Is an unsupported version of DaVinci Resolve installed? | | **Notes** |
  • Supported version refers to any version of DaVinci Resolve equal or higher to cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION
| | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 145](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L145) | --- ### [primaryWindow](#primarywindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.primaryWindow ` | | **Type** | Field | | **Description** | The DaVinci Resolve Primary Window. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 325](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L325) | --- ### [supportedLocales](#supportedlocales) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.supportedLocales ` | | **Type** | Field | | **Description** | The list of supported locales for this version of FCPX. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 117](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L117) | --- ### [UI](#ui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.UI ` | | **Type** | Field | | **Description** | The DaVinci Resolve `axuielement`, if available. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 62](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L62) | --- ### [version](#version) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.version ` | | **Type** | Field | | **Description** | The version number of the running or default installation of FCPX as a `semver`. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 131](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L131) | --- ### [versionString](#versionstring) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.versionString ` | | **Type** | Field | | **Description** | The version number of the running or default installation of FCPX as a `string`. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 138](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L138) | --- ### [windowsUI](#windowsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve.windowsUI ` | | **Type** | Field | | **Description** | Returns the UI containing the list of windows in the app. | | **Notes** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 69](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L69) | --- #### Methods ### [bundleID](#bundleid) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:bundleID() -> string` | | **Type** | Method | | **Description** | Returns the Bundle ID for the app. | | **Parameters** |
  • None
| | **Returns** |
  • The Bundle ID
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 155](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L155) | --- ### [doHide](#dohide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:doHide() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will hide the FCP. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement` to execute.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 266](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L266) | --- ### [doLaunch](#dolaunch) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:doLaunch() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will launch, or focus it if already running FCP. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement` to execute.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 199](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L199) | --- ### [doQuit](#doquit) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:doQuit() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will quit FCP. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement` to execute.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 293](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L293) | --- ### [doRestart](#dorestart) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:doRestart() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.cp) that will restart DaVinci Resolve, if it is running. If not, nothing happens. | | **Parameters** |
  • None.
| | **Returns** |
  • The FCP instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 212](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L212) | --- ### [doShow](#doshow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:doShow() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will show FCP on-screen. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement` to execute.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 239](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L239) | --- ### [getPath](#getpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:getPath() -> string or nil` | | **Type** | Method | | **Description** | Path to DaVinci Resolve Application | | **Parameters** |
  • None
| | **Returns** |
  • A string containing DaVinci Resolve's filesystem path, or nil if DaVinci Resolve's path could not be determined.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 306](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L306) | --- ### [hide](#hide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:hide() -> self` | | **Type** | Method | | **Description** | Hides DaVinci Resolve | | **Parameters** |
  • None
| | **Returns** |
  • The FCP instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 252](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L252) | --- ### [launch](#launch) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:launch([waitSeconds], [path]) -> self` | | **Type** | Method | | **Description** | Launches DaVinci Resolve, or brings it to the front if it was already running. | | **Parameters** |
  • `waitSeconds` - If provided, the number of seconds to wait until the launch completes. If `nil`, it will return immediately.
  • `path` - An optional full path to an application without an extension (i.e `/Applications/DaVinci Resolve 10.3.4`). This allows you to load previous versions of the application.
| | **Returns** |
  • The FCP instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 181](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L181) | --- ### [notifier](#notifier) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve: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.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 168](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L168) | --- ### [quit](#quit) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:quit([waitSeconds]) -> self` | | **Type** | Method | | **Description** | Quits DaVinci Resolve, if it's running. | | **Parameters** |
  • waitSeconds - The number of seconds to wait for the quit to complete.
| | **Returns** |
  • The FCP instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 279](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L279) | --- ### [show](#show) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.blackmagic.resolve:show() -> cp.blackmagic.resolve` | | **Type** | Method | | **Description** | Activate DaVinci Resolve, if it is running. | | **Parameters** |
  • None
| | **Returns** |
  • The FCP instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/blackmagic/resolve/init.lua line 225](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/blackmagic/resolve/init.lua#L225) | --- ---