#cp.apple.finalcutpro.timeline.CaptionsRole

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.CaptionsRole.matches(element) -> boolean`
Type	Function
Description	Checks if the element is a "Captions" Role.
Parameters	element - The element to check
Returns	A boolean
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsRole.lua line 21


Signature	`cp.apple.finalcutpro.timeline.CaptionsRole(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/CaptionsRole.lua line 36


Signature	`cp.apple.finalcutpro.timeline.CaptionsRole.subrolesExpanded <cp.ui.Button>`
Type	Field
Description	A Button that toggles whether the sub-captions are visible.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsRole.lua line 59


Signature	`cp.apple.finalcutpro.timeline.CaptionsRole.visibleInViewer <cp.ui.CheckBox>`
Type	Field
Description	A CheckBox that toggles whether captions are visible in the Viewer.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/timeline/CaptionsRole.lua line 50