#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

Constructors - API calls which return an object, typically one that offers API methods

Fields - Variables which can only be accessed from an object returned by a constructor


#API Documentation

#Functions

Signaturecp.apple.finalcutpro.viewer.InfoBar.matches(element) -> boolean
TypeFunction
DescriptionChecks if the element is an InfoBar instance.
Parameters
  • element - The axuielement to check.
Returns
  • true if it matches the pattern for a Viewer InfoBar.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 23

#Constructors

Signaturecp.apple.finalcutpro.viewer.InfoBar(viewer)
TypeConstructor
DescriptionCreates a new InfoBar instance.
Parameters
Returns
  • The new InfoBar.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 46

#Fields

Signaturecp.apple.finalcutpro.viewer.InfoBar.format <cp.prop: number; read-only>
TypeField
DescriptionProvides the full format text value, or nil if not available.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 77

Signaturecp.apple.finalcutpro.viewer.InfoBar.formatField <cp.ui.StaticText>
TypeField
DescriptionThe "Field" value for the current clip, as a StaticText
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 66

Signaturecp.apple.finalcutpro.viewer.InfoBar.framerate <cp.prop: number; read-only>
TypeField
DescriptionProvides the framerate as a number, or nil if not available.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 84

Signaturecp.apple.finalcutpro.viewer.InfoBar.title <cp.prop: string; read-only; live?>
TypeField
DescriptionProvides the Title of the clip in the Viewer as a StaticText.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 104

Signaturecp.apple.finalcutpro.viewer.InfoBar.titleField <cp.ui.StaticText>
TypeField
DescriptionProvides the Title of the clip in the Viewer as a StaticText.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 95

Signaturecp.apple.finalcutpro.viewer.InfoBar:viewMenu <cp.ui.MenuButton>
TypeField
DescriptionThe MenuButton for the "View" menu.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 111

Signaturecp.apple.finalcutpro.viewer.InfoBar:zoomwMenu <cp.ui.MenuButton>
TypeField
DescriptionThe MenuButton for the "Zoom Level" menu.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/viewer/InfoBar.lua line 120