cp.apple.finalcutpro.viewer.InfoBar.md

docs » cp.apple.finalcutpro.viewer.InfoBar

---

Represents the bar of information about the Viewer (format, title, viewing options).

See also ControlBar.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• InfoBar
• Fields - Variables which can only be accessed from an object returned by a constructor
• format
• formatField
• framerate
• title
• titleField
• viewMenu
• zoomwMenu

API Documentation

Functions

matches

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

Constructors

InfoBar

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

Fields

format

Signature	cp.apple.finalcutpro.viewer.InfoBar.format <cp.prop: number; read-only>
Type	Field
Description	Provides the full format text value, or nil if not available.

formatField

Signature	cp.apple.finalcutpro.viewer.InfoBar.formatField <cp.ui.StaticText>
Type	Field
Description	The "Field" value for the current clip, as a StaticText

framerate

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

title

Signature	cp.apple.finalcutpro.viewer.InfoBar.title <cp.prop: string; read-only; live?>
Type	Field
Description	Provides the Title of the clip in the Viewer as a StaticText.

titleField

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

viewMenu

Signature	cp.apple.finalcutpro.viewer.InfoBar:viewMenu <cp.ui.MenuButton>
Type	Field
Description	The MenuButton for the "View" menu.

zoomwMenu

Signature	cp.apple.finalcutpro.viewer.InfoBar:zoomwMenu <cp.ui.MenuButton>
Type	Field
Description	The MenuButton for the "Zoom Level" menu.