cp.apple.finalcutpro.timeline.IndexRoles.md

docs » cp.apple.finalcutpro.timeline.IndexRoles

---

Provides access to the 'Roles' section of the Timeline Index

API Overview

• Fields - Variables which can only be accessed from an object returned by a constructor
• activate
• area
• collapseSubroles
• editRoles
• hideAudioLanes
• list
• showAudioLanes
• Methods - API calls which can only be made on an object returned by a constructor
• allRoles
• audioRoles
• captionRoles
• doActivate
• doCollapseSubroles
• doDeactivate
• doFocusInTimeline
• doHideAudioLanes
• doHideSubroleLanes
• doLayout
• doShowAudioLanes
• doShowSubroleLanes
• doUnfocusInTimeline
• fineRoleTitled
• saveLayout
• videoRoles

API Documentation

Fields

activate

Signature	cp.apple.finalcutpro.timeline.IndexRoles.activate <cp.ui.RadioButton>
Type	Field
Description	The RadioButton that activates the 'Roles' section.

area

Signature	cp.apple.finalcutpro.timeline.IndexRoles.area <cp.apple.finalcutpro.timeline.IndexRolesArea>
Type	Field
Description	The IndexRolesArea containing the list of Role.

collapseSubroles

Signature	cp.apple.finalcutpro.timeline.IndexRoles.collapseSubroles <cp.ui.Button>
Type	Field
Description	The Collapse Subroles Button.

editRoles

Signature	cp.apple.finalcutpro.timeline.IndexRoles.editRoles <cp.ui.Button>
Type	Field
Description	The Edit Roles... Button.

hideAudioLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles.hideAudioLanes <cp.ui.Button>
Type	Field
Description	The Hide Audio Lanes Button.

list

Signature	cp.apple.finalcutpro.timeline.IndexRoles.list <cp.apple.finalcutpro.timeline.IndexRolesList>
Type	Field
Description	The IndexRolesList for the roles.

showAudioLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles.showAudioLanes <cp.ui.Button>
Type	Field
Description	The Show Audio Lanes Button.

Methods

allRoles

Signature	cp.apple.finalcutpro.timeline.IndexRoles:allRoles([includeSubroles]) -> table of Roles
Type	Method
Description	Finds all Roles, optionally including all Subroles
Parameters	includeSubroles - (defaults to false) if true include subroles.
Returns	The table of Roles, or nil if no UI is available.

audioRoles

Signature	cp.apple.finalcutpro.timeline.IndexRoles:audioRoles([includeSubroles]) -> table of Roles
Type	Method
Description	Finds all Audio Roles, optionally including all Subroles
Parameters	includeSubroles - (defaults to false) if true include subroles.
Returns	The table of Roles, or nil if no UI is available.

captionRoles

Signature	cp.apple.finalcutpro.timeline.IndexRoles:captionRoles([includeSubroles]) -> table of Roles
Type	Method
Description	Finds all Caption Roles, optionally including all Subroles
Parameters	includeSubroles - (defaults to false) if true include subroles.
Returns	The table of Roles, or nil if no UI is available.

doActivate

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doActivate(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will activate the provided role, if it is available.
Parameters	The title of the Role to activate.
Returns	The Statement
Notes	The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.

doCollapseSubroles

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doCollapseSubroles() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will collapse subroles, if they are currently expanded.

doDeactivate

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doDeactivate(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will deactivate the provided role, if it is available.
Parameters	The title of the Role to activate.
Returns	The Statement
Notes	The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.

doFocusInTimeline

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doFocusInTimeline(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will focus the listed role, if it is available and is an AudioRole.
Parameters	The title of the Role to activate.
Returns	The Statement
Notes	The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.

doHideAudioLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doHideAudioLanes() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will collapse subroles (if necessary) and hide the audio lanes.

doHideSubroleLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doHideSubroleLanes(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will hide the subrole lanes for the listed role, if it is available and is an AudioRole.
Parameters	The title of the Role.
Returns	The Statement
Notes	The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.

doLayout

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doLayout(layout) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will apply the layout provided, if possible.
Parameters	layout - the table containing the layout configuration. Usually created via the [#saveLayout] method.
Returns	The Statement.

doShowAudioLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doShowAudioLanes() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will show the Audio Lanes when executed.

doShowSubroleLanes

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doShowSubroleLanes(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will show subrole lanes for the role, if it is available and is an AudioRole.
Parameters	The title of the Role.
Returns	The Statement
Notes	The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.

doUnfocusInTimeline

Signature	cp.apple.finalcutpro.timeline.IndexRoles:doUnfocusInTimeline(title) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will unfocus the listed role, if it is available and is an AudioRole.
Parameters	The title of the Role to activate.
Returns	The Statement
Notes	The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.

fineRoleTitled

Signature	cp.apple.finalcutpro.timeline.IndexRoles:fineRoleTitled(title) -> Role or nil
Type	Method
Description	Finds the Role with the specified title.
Parameters	title - The title to match.
Returns	The Role with the title, or nil.
Notes	The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.

saveLayout

Signature	cp.apple.finalcutpro.timeline.IndexRoles:saveLayout() -> table
Type	Method
Description	Returns a table containing the layout configuration for this class.
Returns	The layout configuration table.

videoRoles

Signature	cp.apple.finalcutpro.timeline.IndexRoles:videoRoles([includeSubroles]) -> table of Roles
Type	Method
Description	Finds all Video Roles, optionally including all Subroles
Parameters	includeSubroles - (defaults to false) if true include subroles.
Returns	The table of Roles, or nil if no UI is available.