cp.blackmagic.resolve.md

docs » cp.blackmagic.resolve

---

The Blackmagic DaVinci Resolve Extension.

Submodules

• cp.blackmagic.resolve.app
• cp.blackmagic.resolve.color
• cp.blackmagic.resolve.main

API Overview

• Constants - Useful values which cannot be changed
• EARLIEST_SUPPORTED_VERSION
• preferences
• Fields - Variables which can only be accessed from an object returned by a constructor
• Color
• currentLocale
• isFrontmost
• isInstalled
• isModalDialogOpen
• isRunning
• isShowing
• isSupported
• isUnsupported
• primaryWindow
• supportedLocales
• UI
• version
• versionString
• windowsUI
• Methods - API calls which can only be made on an object returned by a constructor
• bundleID
• doHide
• doLaunch
• doQuit
• doRestart
• doShow
• getPath
• hide
• launch
• notifier
• quit
• show

API Documentation

Constants

EARLIEST_SUPPORTED_VERSION

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

preferences

Signature	cp.blackmagic.resolve.preferences <cp.app.prefs>
Type	Constant
Description	The cp.app.prefs for DaVinci Resolve.

Fields

Color

Signature	cp.blackmagic.resolve.Color <cp.blackmagic.resolve.Color>
Type	Field
Description	The Color Workspace.
Parameters	None
Returns	the Browser

currentLocale

Signature	cp.blackmagic.resolve.currentLocale <cp.prop: cp.i18n.localeID; live>
Type	Field
Description	Gets and sets the current locale for FCPX.

isFrontmost

Signature	cp.blackmagic.resolve:isFrontmost <cp.prop: boolean; read-only; live>
Type	Field
Description	Is DaVinci Resolve Frontmost?

isInstalled

Signature	cp.blackmagic.resolve.isInstalled <cp.prop: boolean; read-only>
Type	Field
Description	Is any version of DaVinci Resolve Installed?

isModalDialogOpen

Signature	cp.blackmagic.resolve:isModalDialogOpen <cp.prop: boolean; read-only>
Type	Field
Description	Is a modal dialog currently open?

isRunning

Signature	cp.blackmagic.resolve.isRunning <cp.prop: boolean; read-only>
Type	Field
Description	Is DaVinci Resolve Running?

isShowing

Signature	cp.blackmagic.resolve.isShowing <cp.prop: boolean; read-only; live>
Type	Field
Description	Is Final Cut visible on screen?

isSupported

Signature	cp.blackmagic.resolve.isSupported <cp.prop: boolean; read-only; live>
Type	Field
Description	Is a supported version of DaVinci Resolve installed?

isUnsupported

Signature	cp.blackmagic.resolve.isUnsupported <cp.prop: boolean; read-only>
Type	Field
Description	Is an unsupported version of DaVinci Resolve installed?

primaryWindow

Signature	cp.blackmagic.resolve.primaryWindow <PrimaryWindow>
Type	Field
Description	The DaVinci Resolve Primary Window.

supportedLocales

Signature	cp.blackmagic.resolve.supportedLocales <cp.prop: table of cp.i18n.localeID; read-only>
Type	Field
Description	The list of supported locales for this version of FCPX.

UI

Signature	cp.blackmagic.resolve.UI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	The DaVinci Resolve axuielement, if available.

version

Signature	cp.blackmagic.resolve.version <cp.prop: semver; read-only; live>
Type	Field
Description	The version number of the running or default installation of FCPX as a semver.

versionString

Signature	cp.blackmagic.resolve.versionString <cp.prop: string; read-only; live>
Type	Field
Description	The version number of the running or default installation of FCPX as a string.

windowsUI

Signature	cp.blackmagic.resolve.windowsUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	Returns the UI containing the list of windows in the app.

Methods

bundleID

Signature	cp.blackmagic.resolve:bundleID() -> string
Type	Method
Description	Returns the Bundle ID for the app.
Parameters	None
Returns	The Bundle ID

doHide

Signature	cp.blackmagic.resolve:doHide() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will hide the FCP.
Parameters	None
Returns	The Statement to execute.

doLaunch

Signature	cp.blackmagic.resolve:doLaunch() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will launch, or focus it if already running FCP.
Parameters	None
Returns	The Statement to execute.

doQuit

Signature	cp.blackmagic.resolve:doQuit() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will quit FCP.
Parameters	None
Returns	The Statement to execute.

doRestart

Signature	cp.blackmagic.resolve:doRestart() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will restart DaVinci Resolve, if it is running. If not, nothing happens.
Parameters	None.
Returns	The FCP instance.

doShow

Signature	cp.blackmagic.resolve:doShow() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will show FCP on-screen.
Parameters	None
Returns	The Statement to execute.

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.

hide

Signature	cp.blackmagic.resolve:hide() -> self
Type	Method
Description	Hides DaVinci Resolve
Parameters	None
Returns	The FCP instance.

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.

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.

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.

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.