# cp.apple.finalcutpro.viewer.Viewer Viewer Module. --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [BACKGROUND](#background) * [PLAYBACK_MODE](#playback_mode) **Functions** - _API calls offered directly by the extension_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [Viewer](#viewer) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [background](#background) * [betterQuality](#betterquality) * [contentsUI](#contentsui) * [controlBar](#controlbar) * [frame](#frame) * [framerate](#framerate) * [getFormat](#getformat) * [hasPlayerControls](#hasplayercontrols) * [infoBar](#infobar) * [isEventViewer](#iseventviewer) * [isMainViewer](#ismainviewer) * [isOnPrimary](#isonprimary) * [isOnSecondary](#isonsecondary) * [playbackMode](#playbackmode) * [playButton](#playbutton) * [timecode](#timecode) * [timecodeField](#timecodefield) * [title](#title) * [usingProxies](#usingproxies) * [videoImage](#videoimage) * [videoImageUI](#videoimageui) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [app](#app) * [currentWindow](#currentwindow) * [doHide](#dohide) * [doPause](#dopause) * [doPlay](#doplay) * [doShowOnPrimary](#doshowonprimary) * [doShowOnSecondary](#doshowonsecondary) * [hide](#hide) * [notifier](#notifier) * [showOnPrimary](#showonprimary) * [showOnSecondary](#showonsecondary) --- ## API Documentation #### Constants ### [BACKGROUND](#background) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.BACKGROUND -> table` | | **Type** | Constant | | **Description** | Lists the possible background values: `BLACK`, `WHITE`, `CHECKERBOARD`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 472](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L472) | --- ### [PLAYBACK_MODE](#playback_mode) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.PLAYBACK_MODE -> table` | | **Type** | Constant | | **Description** | Lists the possible playback modes for the viewer: `ORIGINAL_BETTER_QUALITY`, `ORIGINAL_BETTER_PERFORMANCE`, `PROXY_PREFERRED`, `PROXY_ONLY`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 383](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L383) | --- #### Functions ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks to see if an element matches what we think it should be. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 101](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L101) | --- #### Constructors ### [Viewer](#viewer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer(app, eventViewer) -> Viewer` | | **Type** | Constructor | | **Description** | Creates a new `Viewer` instance. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 121](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L121) | --- #### Fields ### [background](#background) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.background -> ` | | **Type** | Field | | **Description** | The viewer background mode. See `Viewer.BACKGROUND` for options. | | **Notes** | | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 481](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L481) | --- ### [betterQuality](#betterquality) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.betterQuality ` | | **Type** | Field | | **Description** | Checks if the viewer is using playing with better quality (`true`) or performance (`false). | | **Notes** | | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 457](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L457) | --- ### [contentsUI](#contentsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.contentsUI ` | | **Type** | Field | | **Description** | Provides the `axuielement` for the media contents of the Viewer, or `nil` if not available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 252](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L252) | --- ### [controlBar](#controlbar) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.controlBar ` | | **Type** | Field | | **Description** | Provides the [ControlBar](cp.apple.finalcutpro.viewer.ControlBar.md) for this `Viewer`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 295](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L295) | --- ### [frame](#frame) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.frame ` | | **Type** | Field | | **Description** | Returns the current frame for the viewer, or `nil` if it is not available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 242](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L242) | --- ### [framerate](#framerate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.framerate ` | | **Type** | Field | | **Description** | Provides the framerate as a number, or nil if not available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 498](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L498) | --- ### [getFormat](#getformat) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.getFormat ` | | **Type** | Field | | **Description** | Provides the format text value, or `nil` if none is available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 491](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L491) | --- ### [hasPlayerControls](#hasplayercontrols) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.hasPlayerControls ` | | **Type** | Field | | **Description** | Checks if the viewer has Player Controls visible. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 318](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L318) | --- ### [infoBar](#infobar) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.infoBar ` | | **Type** | Field | | **Description** | Provides the [InfoBar](cp.apple.finalcutpro.viewer.InfoBar.md) for this `Viewer`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 287](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L287) | --- ### [isEventViewer](#iseventviewer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.isEventViewer ` | | **Type** | Field | | **Description** | Returns `true` if this is the Event Viewer. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 518](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L518) | --- ### [isMainViewer](#ismainviewer) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.isMainViewer ` | | **Type** | Field | | **Description** | Returns `true` if this is the main Viewer. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 511](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L511) | --- ### [isOnPrimary](#isonprimary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.isOnPrimary ` | | **Type** | Field | | **Description** | Checks if the Viewer is showing on the Primary Window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 232](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L232) | --- ### [isOnSecondary](#isonsecondary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.isOnSecondary ` | | **Type** | Field | | **Description** | Checks if the Viewer is showing on the Secondary Window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 222](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L222) | --- ### [playbackMode](#playbackmode) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.playbackMode -> Viewer.PLAYBACK_MODE` | | **Type** | Field | | **Description** | Reports and allows modification of the current playback mode. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 393](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L393) | --- ### [playButton](#playbutton) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.playButton ` | | **Type** | Field | | **Description** | The Play [Button](cp.ui.Button.md) object. | | **Parameters** |
  • None
| | **Returns** |
  • A Button
| | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 713](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L713) | --- ### [timecode](#timecode) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.timecode ` | | **Type** | Field | | **Description** | The current timecode value, with the format "hh:mm:ss:ff". Setting also supports "hh:mm:ss;ff". | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 310](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L310) | --- ### [timecodeField](#timecodefield) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.timecodeField ` | | **Type** | Field | | **Description** | The [StaticText](cp.ui.StaticText.md) containing the timecode value. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 303](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L303) | --- ### [title](#title) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.title ` | | **Type** | Field | | **Description** | Provides the Title of the clip in the Viewer as a [StaticText](cp.ui.StaticText.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 325](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L325) | --- ### [usingProxies](#usingproxies) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.usingProxies ` | | **Type** | Field | | **Description** | Indicates if the viewer is using Proxies (`true`) or Optimized/Original media (`false`). | | **Notes** |
  • Use `playbackMode` to change modes between original/proxy/quality/performance.
| | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 443](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L443) | --- ### [videoImage](#videoimage) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.videoImage ` | | **Type** | Field | | **Description** | The `Image` for the video content. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 280](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L280) | --- ### [videoImageUI](#videoimageui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.videoImageUI ` | | **Type** | Field | | **Description** | Provides the `axuielement` for video image within the Viewer, or `nil` if not available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 267](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L267) | --- #### Methods ### [app](#app) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:app() -> application` | | **Type** | Method | | **Description** | Returns the application. | | **Parameters** |
  • None
| | **Returns** |
  • The application.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 209](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L209) | --- ### [currentWindow](#currentwindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:currentWindow() -> PrimaryWindow | SecondaryWindow` | | **Type** | Method | | **Description** | Gets the current window object. | | **Parameters** |
  • None
| | **Returns** |
  • The `PrimaryWindow` or the `SecondaryWindow`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 531](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L531) | --- ### [doHide](#dohide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:doHide() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that hides the Viewer. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, resolving to `true`, or sends an error.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 684](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L684) | --- ### [doPause](#dopause) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer.doPause() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Pause the `Viewer`. | | **Parameters** |
  • None
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 359](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L359) | --- ### [doPlay](#doplay) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:doPlay() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will play the `Viewer`. | | **Parameters** |
  • None
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md).
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 344](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L344) | --- ### [doShowOnPrimary](#doshowonprimary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:doShowOnPrimary() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that shows the Viewer on the Primary display. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, which resolves to `true`, or sends an error message.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 578](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L578) | --- ### [doShowOnSecondary](#doshowonsecondary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:doShowOnSecondary() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that shows the Viewer on the Secondary display. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, resolving to `true`, or sending an error message.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 630](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L630) | --- ### [hide](#hide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:hide() -> self` | | **Type** | Method | | **Description** | Hides the Viewer. | | **Parameters** |
  • None
| | **Returns** |
  • Self
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 656](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L656) | --- ### [notifier](#notifier) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer: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/apple/finalcutpro/viewer/Viewer.lua line 726](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L726) | --- ### [showOnPrimary](#showonprimary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:showOnPrimary() -> self` | | **Type** | Method | | **Description** | Shows the Viewer on the Primary display. | | **Parameters** |
  • None
| | **Returns** |
  • Self
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 548](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L548) | --- ### [showOnSecondary](#showonsecondary) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.viewer.Viewer:showOnSecondary() -> self` | | **Type** | Method | | **Description** | Shows the Viewer on the Seconary display. | | **Parameters** |
  • None
| | **Returns** |
  • Self
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua line 604](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/viewer/Viewer.lua#L604) | --- ---