# cp.apple.finalcutpro.timeline.IndexRoles Provides access to the 'Roles' section of the [Timeline Index](cp.apple.finalcutpro.timeline.Index.md) --- ## API Overview **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [activate](#activate) * [area](#area) * [collapseSubroles](#collapsesubroles) * [editRoles](#editroles) * [hideAudioLanes](#hideaudiolanes) * [list](#list) * [showAudioLanes](#showaudiolanes) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [allRoles](#allroles) * [audioRoles](#audioroles) * [captionRoles](#captionroles) * [doActivate](#doactivate) * [doCollapseSubroles](#docollapsesubroles) * [doDeactivate](#dodeactivate) * [doFocusInTimeline](#dofocusintimeline) * [doHideAudioLanes](#dohideaudiolanes) * [doHideSubroleLanes](#dohidesubrolelanes) * [doLayout](#dolayout) * [doShowAudioLanes](#doshowaudiolanes) * [doShowSubroleLanes](#doshowsubrolelanes) * [doUnfocusInTimeline](#dounfocusintimeline) * [fineRoleTitled](#fineroletitled) * [saveLayout](#savelayout) * [videoRoles](#videoroles) --- ## API Documentation #### Fields ### [activate](#activate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.activate ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) that activates the 'Roles' section. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 26](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L26) | --- ### [area](#area) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.area ` | | **Type** | Field | | **Description** | The [IndexRolesArea](cp.apple.finalcutpro.timeline.IndexRolesArea.md) containing the list of [Role](cp.apple.finalcutpro.timeline.Role.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 47](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L47) | --- ### [collapseSubroles](#collapsesubroles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.collapseSubroles ` | | **Type** | Field | | **Description** | The `Collapse Subroles` [Button](cp.ui.Button.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 94](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L94) | --- ### [editRoles](#editroles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.editRoles ` | | **Type** | Field | | **Description** | The `Edit Roles...` [Button](cp.ui.Button.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 65](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L65) | --- ### [hideAudioLanes](#hideaudiolanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.hideAudioLanes ` | | **Type** | Field | | **Description** | The `Hide Audio Lanes` [Button](cp.ui.Button.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 85](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L85) | --- ### [list](#list) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.list ` | | **Type** | Field | | **Description** | The [IndexRolesList](cp.apple.finalcutpro.timeline.IndexRolesList.md) for the roles. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 58](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L58) | --- ### [showAudioLanes](#showaudiolanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles.showAudioLanes ` | | **Type** | Field | | **Description** | The `Show Audio Lanes` [Button](cp.ui.Button.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 76](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L76) | --- #### Methods ### [allRoles](#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 [Role](cp.apple.finalcutpro.timeline.Role.md)s, or `nil` if no UI is available.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 206](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L206) | --- ### [audioRoles](#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 [Role](cp.apple.finalcutpro.timeline.Role.md)s, or `nil` if no UI is available.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 232](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L232) | --- ### [captionRoles](#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 [Role](cp.apple.finalcutpro.timeline.Role.md)s, or `nil` if no UI is available.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 245](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L245) | --- ### [doActivate](#doactivate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doActivate(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will activate the provided role, if it is available. This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md) to activate.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 274](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L274) | --- ### [doCollapseSubroles](#docollapsesubroles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doCollapseSubroles() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will collapse subroles, if they are currently expanded. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 135](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L135) | --- ### [doDeactivate](#dodeactivate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doDeactivate(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will deactivate the provided role, if it is available. This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md) to activate.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 294](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L294) | --- ### [doFocusInTimeline](#dofocusintimeline) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doFocusInTimeline(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will focus the listed role, if it is available and is an [AudioRole](cp.apple.finalcutpro.timeline.AudioRole.md). This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md) to activate.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 323](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L323) | --- ### [doHideAudioLanes](#dohideaudiolanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doHideAudioLanes() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will collapse subroles (if necessary) and hide the audio lanes. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 150](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L150) | --- ### [doHideSubroleLanes](#dohidesubrolelanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doHideSubroleLanes(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will hide the subrole lanes for the listed role, if it is available and is an [AudioRole](cp.apple.finalcutpro.timeline.AudioRole.md). This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md).
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 383](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L383) | --- ### [doLayout](#dolayout) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doLayout(layout) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) 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](cp.rx.go.Statement.md).
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 183](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L183) | --- ### [doShowAudioLanes](#doshowaudiolanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doShowAudioLanes() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will show the Audio Lanes when executed. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 120](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L120) | --- ### [doShowSubroleLanes](#doshowsubrolelanes) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doShowSubroleLanes(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will show subrole lanes for the role, if it is available and is an [AudioRole](cp.apple.finalcutpro.timeline.AudioRole.md). This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md).
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 363](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L363) | --- ### [doUnfocusInTimeline](#dounfocusintimeline) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:doUnfocusInTimeline(title) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will unfocus the listed role, if it is available and is an [AudioRole](cp.apple.finalcutpro.timeline.AudioRole.md). This will automatically show and hide the Index if it is not currently visible. | | **Parameters** |
  • The title of the [Role](cp.apple.finalcutpro.timeline.Role.md) to activate.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 343](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L343) | --- ### [fineRoleTitled](#fineroletitled) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:fineRoleTitled(title) -> Role or nil` | | **Type** | Method | | **Description** | Finds the [Role](cp.apple.finalcutpro.timeline.Role.md) with the specified title. | | **Parameters** |
  • title - The title to match.
| | **Returns** |
  • The [Role](cp.apple.finalcutpro.timeline.Role.md) 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.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 258](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L258) | --- ### [saveLayout](#savelayout) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexRoles:saveLayout() -> table` | | **Type** | Method | | **Description** | Returns a `table` containing the layout configuration for this class. | | **Parameters** |
  • None
| | **Returns** |
  • The layout configuration `table`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 166](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L166) | --- ### [videoRoles](#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 [Role](cp.apple.finalcutpro.timeline.Role.md)s, or `nil` if no UI is available.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua line 219](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexRoles.lua#L219) | --- ---