cp.apple.finalcutpro.viewer.ControlBar.md

docs » cp.apple.finalcutpro.viewer.ControlBar

---

Represents the bottom "control" bar on a Viewer which contains the play/pause button, timecode, audio meters, etc.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• ControlBar
• Fields - Variables which can only be accessed from an object returned by a constructor
• timecode

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.viewer.ControlBar.matches(element) -> boolean
Type	Function
Description	Checks if the element is a ControlBar instance.
Parameters	element - The axuielement to check.
Returns	true if it matches the pattern for a Viewer ControlBar.

Constructors

ControlBar

Signature	cp.apple.finalcutpro.viewer.ControlBar(viewer)
Type	Constructor
Description	Creates a new ControlBar instance.
Parameters	viewer - The Viewer instance.
Returns	The new ControlBar.

Fields

timecode

Signature	cp.apple.finalcutpro.viewer.ControlBar.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".