# cp.apple.finalcutpro.timeline.Contents Timeline Contents Module. --- ## API Overview **Functions** - _API calls offered directly by the extension_ * [clipsUI](#clipsui) * [matches](#matches) * [playheadClipsUI](#playheadclipsui) * [positionClipsUI](#positionclipsui) * [skimmingPlayheadClipsUI](#skimmingplayheadclipsui) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [Contents](#contents) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [children](#children) * [isLoaded](#isloaded) * [playhead](#playhead) * [scrollArea](#scrollarea) * [scrollAreaUI](#scrollareaui) * [selectedChildren](#selectedchildren) * [skimmingPlayhead](#skimmingplayhead) * [viewFrame](#viewframe) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [activePlayhead](#activeplayhead) * [doFocus](#dofocus) * [doHide](#dohide) * [doSelectClip](#doselectclip) * [doSelectClips](#doselectclips) * [doSelectNone](#doselectnone) * [doSelectTopClip](#doselecttopclip) * [doShow](#doshow) * [rangeSelectionUI](#rangeselectionui) * [selectedClipsUI](#selectedclipsui) --- ## API Documentation #### Functions ### [clipsUI](#clipsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:clipsUI(expandedGroups, filterFn) -> table of axuielements` | | **Type** | Function | | **Description** | Returns a table containing the list of clips in the Timeline. | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 274](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L274) | --- ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks if an `axuielementObject` matches the `Contents` type. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 28](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L28) | --- ### [playheadClipsUI](#playheadclipsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:playheadClipsUI(expandedGroups, filterFn) -> table of axuielements` | | **Type** | Function | | **Description** | Returns a table array containing the list of clips in the Timeline under the playhead, ordered with the highest clips at the beginning of the array. | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 345](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L345) | --- ### [positionClipsUI](#positionclipsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:positionClipsUI(position, expandedGroups, filterFn) -> table of axuielements` | | **Type** | Function | | **Description** | Returns a table array containing the list of clips in the Timeline at the specified `position`, ordered with the highest clips at the beginning of the array. | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 318](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L318) | --- ### [skimmingPlayheadClipsUI](#skimmingplayheadclipsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:skimmingPlayheadClipsUI(expandedGroups, filterFn) -> table of axuielements` | | **Type** | Function | | **Description** | Returns a table array containing the list of clips in the Timeline under the skimming playhead, ordered with the highest clips at the beginning of the array. | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 363](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L363) | --- #### Constructors ### [Contents](#contents) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents(parent) -> Contents` | | **Type** | Constructor | | **Description** | Creates a new Timeline `Contents` instance. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 43](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L43) | --- #### Fields ### [children](#children) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.children ` | | **Type** | Field | | **Description** | The current set of child elements in the Contents. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 115](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L115) | --- ### [isLoaded](#isloaded) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.isLoaded ` | | **Type** | Field | | **Description** | Checks if the Timeline has content loaded. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 139](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L139) | --- ### [playhead](#playhead) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.playhead ` | | **Type** | Field | | **Description** | The main Playhead. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 196](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L196) | --- ### [scrollArea](#scrollarea) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.scrollArea ` | | **Type** | Field | | **Description** | The `ScrollArea` for the Contents element. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 94](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L94) | --- ### [scrollAreaUI](#scrollareaui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.scrollAreaUI ` | | **Type** | Field | | **Description** | The parent `ScrollArea` UI of the Timeline Contents area. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 84](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L84) | --- ### [selectedChildren](#selectedchildren) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.selectedChildren ` | | **Type** | Field | | **Description** | The current set of selected child elements in the Contents. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 127](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L127) | --- ### [skimmingPlayhead](#skimmingplayhead) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.skimmingPlayhead ` | | **Type** | Field | | **Description** | The Playhead that tracks with the mouse pointer. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 203](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L203) | --- ### [viewFrame](#viewframe) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents.viewFrame ` | | **Type** | Field | | **Description** | The current 'frame' of the internal timeline content, or `nil` if not available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 108](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L108) | --- #### Methods ### [activePlayhead](#activeplayhead) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:activePlayhead() -> Playhead` | | **Type** | Method | | **Description** | Returns the active Playhead. If the Skimming Playhead is available, return that, otherwise, return the normal Playhead. | | **Parameters** |
  • None
| | **Returns** |
  • The active `Playhead`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 211](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L211) | --- ### [doFocus](#dofocus) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doFocus(show) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) which will focus on the `Contents`. | | **Parameters** |
  • show - if `true`, the `Contents` will be shown before focusing.
| | **Returns** |
  • The `Statement`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 576](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L576) | --- ### [doHide](#dohide) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doHide() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will attempt to hide the Timeline Contents. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 177](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L177) | --- ### [doSelectClip](#doselectclip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doSelectClip(clipUI) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) which will select the specified single `hs.axuielement` value in the Timeline Contents area. | | **Parameters** |
  • clipUI - The `hs._asm.axuilement` values to select.
| | **Returns** |
  • A [Statement](cp.rx.go.Statement.md) that will select the clip or throw an error if there is an issue.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 529](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L529) | --- ### [doSelectClips](#doselectclips) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doSelectClips(clipsUI) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) which will select the specified list of `hs.axuielement` values in the Timeline Contents area. | | **Parameters** |
  • clipsUI - The table of `hs._asm.axuilement` values to select.
| | **Returns** |
  • A [Statement](cp.rx.go.Statement.md) that will select the clips or throw an error if there is an issue.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 502](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L502) | --- ### [doSelectNone](#doselectnone) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doSelectNone() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will clear any clip selection. | | **Parameters** |
  • None
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 480](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L480) | --- ### [doSelectTopClip](#doselecttopclip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doSelectTopClip([position]) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Creates a [Statement](cp.rx.go.Statement.md) that will select the top clip at the given position, resolving to the top clip if available. | | **Parameters** |
  • position - (optional) The position `table` to select the top clip at. If not provided, the current active playhead position is used.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement)
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 550](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L550) | --- ### [doShow](#doshow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:doShow() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that will attempt to show the Timeline Contents. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 158](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L158) | --- ### [rangeSelectionUI](#rangeselectionui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:rangeSelectionUI() -> axuielements` | | **Type** | Method | | **Description** | Returns the UI for the current 'Range Selection', if present. | | **Parameters** |
  • None
| | **Returns** |
  • The 'Range Selection' UI or `nil`
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 300](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L300) | --- ### [selectedClipsUI](#selectedclipsui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Contents:selectedClipsUI(expandedGroups, filterFn) -> table of axuielements` | | **Type** | Method | | **Description** | Returns a table containing the list of selected clips. | | **Parameters** |
  • expandGroups - (optional) if true, expand AXGroups to include contained AXLayoutItems
  • filterFn - (optional) if provided, the function will be called to check each clip
| | **Returns** |
  • The table of selected axuielements that match the conditions
| | **Notes** |
  • If `expandsGroups` is true any AXGroup items will be expanded to the list of contained AXLayoutItems.
  • If `filterFn` is provided it will be called with a single argument to check if the provided clip should be included in the final table.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Contents.lua line 252](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Contents.lua#L252) | --- ---