cp.apple.finalcutpro.timeline.CaptionsSubrole

Extends Role

A Role representing Captions.

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


Signature	`cp.apple.finalcutpro.timeline.CaptionsSubrole.matches(element) -> boolean`
Type	Function
Description	Checks if the element is a "Captions" Subrole.
Parameters	element - An element to check
Returns	A boolean
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsSubrole.lua line 16


Signature	`cp.apple.finalcutpro.timeline.CaptionsSubrole(parent, uiFinder)`
Type	Constructor
Description	Creates a new instance with the specified `parent` and `uiFinder`.
Parameters	parent - the parent `Element`. uiFinder - a `function` or `cp.prop` containing the `axuielement`
Returns	The new `Row`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsSubrole.lua line 30


Signature	`cp.apple.finalcutpro.timeline.CaptionsSubrole.format <cp.ui.StaticText>`
Type	Field
Description	A StaticText which represents the subtitle format (e.g. "ITT", "SRT").
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsSubrole.lua line 44


Signature	`cp.apple.finalcutpro.timeline.CaptionsSubrole.visibleInTimeline <cp.ui.CheckBox>`
Type	Field
Description	A CheckBox that indicates if the subtitle track is visible in the Viewer.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsSubrole.lua line 53