cp.apple.finalcutpro.viewer.Viewer.md

docs » cp.apple.finalcutpro.viewer.Viewer

---

Viewer Module.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• Viewer
• Fields - Variables which can only be accessed from an object returned by a constructor
• betterQuality
• contentsUI
• controlBar
• frame
• framerate
• getFormat
• hasPlayerControls
• infoBar
• isEventViewer
• isMainViewer
• isOnPrimary
• isOnSecondary
• playButton
• playerQuality
• timecode
• timecodeField
• title
• usingProxies
• Methods - API calls which can only be made on an object returned by a constructor
• app
• currentWindow
• doHide
• doShowOnPrimary
• doShowOnSecondary
• hide
• notifier
• showOnPrimary
• showOnSecondary

API Documentation

Functions

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	element - An axuielementObject to check.
Returns	true if matches otherwise false

Constructors

Viewer

Signature	cp.apple.finalcutpro.viewer.Viewer(app, eventViewer) -> Viewer
Type	Constructor
Description	Creates a new Viewer instance.
Parameters	app - The FCP application. eventViewer - If true, the viewer is the Event Viewer.
Returns	The new Viewer instance.

Fields

betterQuality

Signature	cp.apple.finalcutpro.viewer.Viewer.betterQuality <cp.prop: boolean>
Type	Field
Description	Indicates if the viewer is using playing with better quality (true) or performance (`false).

contentsUI

Signature	cp.apple.finalcutpro.viewer.Viewer.contentsUI <cp.prop: hs._asm.axuielement; read-only>
Type	Field
Description	Provides the axuielement for the media contents of the Viewer, or nil if not available.

controlBar

Signature	cp.apple.finalcutpro.viewer.Viewer.controlBar <cp.apple.finalcutpro.viewer.ControlBar>
Type	Field
Description	Provides the ControlBar for this Viewer.

frame

Signature	cp.apple.finalcutpro.viewer.Viewer.frame <cp.prop: table; read-only>
Type	Field
Description	Returns the current frame for the viewer, or nil if it is not available.

framerate

Signature	cp.apple.finalcutpro.viewer.Viewer.framerate <cp.prop: number; read-only>
Type	Field
Description	Provides the framerate as a number, or nil if not available.

getFormat

Signature	cp.apple.finalcutpro.viewer.Viewer.getFormat <cp.prop: string; read-only>
Type	Field
Description	Provides the format text value, or nil if none is available.

hasPlayerControls

Signature	cp.apple.finalcutpro.viewer.Viewer.hasPlayerControls <cp.prop: boolean; read-only>
Type	Field
Description	Checks if the viewer has Player Controls visible.

infoBar

Signature	cp.apple.finalcutpro.viewer.Viewer.infoBar <cp.apple.finalcutpro.viewer.InfoBar>
Type	Field
Description	Provides the InfoBar for this Viewer.

isEventViewer

Signature	cp.apple.finalcutpro.viewer.Viewer.isEventViewer <cp.prop: boolean>
Type	Field
Description	Returns true if this is the Event Viewer.

isMainViewer

Signature	cp.apple.finalcutpro.viewer.Viewer.isMainViewer <cp.prop: boolean>
Type	Field
Description	Returns true if this is the main Viewer.

isOnPrimary

Signature	cp.apple.finalcutpro.viewer.Viewer.isOnPrimary <cp.prop: boolean; read-only>
Type	Field
Description	Checks if the Viewer is showing on the Primary Window.

isOnSecondary

Signature	cp.apple.finalcutpro.viewer.Viewer.isOnSecondary <cp.prop: boolean; read-only>
Type	Field
Description	Checks if the Viewer is showing on the Secondary Window.

playButton

Signature	cp.apple.finalcutpro.viewer.Viewer.playButton <cp.ui.Button>
Type	Field
Description	The Play Button object.
Parameters	None
Returns	A Button

playerQuality

Signature	cp.apple.finalcutpro.viewer.Viewer.playerQuality <cp.prop: string>
Type	Field
Description	The current player quality value.

timecode

Signature	cp.apple.finalcutpro.viewer.Viewer.timecode <cp.prop: string; live>
Type	Field
Description	The current timecode value, with the format "hh:mm:ss:ff". Setting also supports "hh:mm:ss;ff".

timecodeField

Signature	cp.apple.finalcutpro.viewer.Viewer.timecodeField <cp.ui.StaticText>
Type	Field
Description	The StaticText containing the timecode value.

title

Signature	cp.apple.finalcutpro.viewer.Viewer.title <cp.ui.StaticText>
Type	Field
Description	Provides the Title of the clip in the Viewer as a StaticText

usingProxies

Signature	cp.apple.finalcutpro.viewer.Viewer.usingProxies <cp.prop: boolean>
Type	Field
Description	Indicates if the viewer is using Proxies (true) or Optimized/Original media (false).

Methods

app

Signature	cp.apple.finalcutpro.viewer.Viewer:app() -> application
Type	Method
Description	Returns the application.
Parameters	None
Returns	The application.

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.

|

doHide

Signature	cp.apple.finalcutpro.viewer.Viewer:doHide() -> cp.rx.go.Statement
Type	Method
Description	A Statement that hides the Viewer.
Parameters	None
Returns	The Statement, resolving to true, or sends an error.

doShowOnPrimary

Signature	cp.apple.finalcutpro.viewer.Viewer:doShowOnPrimary() -> cp.rx.go.Statement
Type	Method
Description	A Statement that shows the Viewer on the Primary display.
Parameters	None
Returns	The Statement, which resolves to true, or sends an error message.

doShowOnSecondary

Signature	cp.apple.finalcutpro.viewer.Viewer:doShowOnSecondary() -> cp.rx.go.Statement
Type	Method
Description	A Statement that shows the Viewer on the Secondary display.
Parameters	None
Returns	The Statement, resolving to true, or sending an error message.

hide

Signature	cp.apple.finalcutpro.viewer.Viewer:hide() -> self
Type	Method
Description	Hides the Viewer.
Parameters	None
Returns	Self

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.

showOnPrimary

Signature	cp.apple.finalcutpro.viewer.Viewer:showOnPrimary() -> self
Type	Method
Description	Shows the Viewer on the Primary display.
Parameters	None
Returns	Self

showOnSecondary

Signature	cp.apple.finalcutpro.viewer.Viewer:showOnSecondary() -> self
Type	Method
Description	Shows the Viewer on the Seconary display.
Parameters	None
Returns	Self