# cp.apple.finalcutpro.timeline.IndexClips *Extends [IndexSection](cp.apple.finalcutpro.timeline.IndexSection.md)* Provides access to the 'Clips' section of the [Timeline Index](cp.apple.finalcutpro.timeline.Index.md) --- ## Submodules * [cp.apple.finalcutpro.timeline.IndexClips.Type](cp.apple.finalcutpro.timeline.IndexClips.Type.md) --- ## API Overview **Constructors** - _API calls which return an object, typically one that offers API methods_ * [IndexClips](#indexclips) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [activate](#activate) * [all](#all) * [audio](#audio) * [list](#list) * [titles](#titles) * [type](#type) * [video](#video) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [doFindAuditions](#dofindauditions) * [doFindClipsContaining](#dofindclipscontaining) * [doFindCompoundClips](#dofindcompoundclips) * [doFindMissingMedia](#dofindmissingmedia) * [doFindMulticams](#dofindmulticams) * [doFindSynchronized](#dofindsynchronized) * [doLayout](#dolayout) * [doShowAll](#doshowall) * [doShowAudio](#doshowaudio) * [doShowTitles](#doshowtitles) * [doShowVideo](#doshowvideo) * [saveLayout](#savelayout) --- ## API Documentation #### Constructors ### [IndexClips](#indexclips) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips(index) -> IndexClips` | | **Type** | Constructor | | **Description** | Creates the `IndexClips` instance. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 27](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L27) | --- #### Fields ### [activate](#activate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.activate ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) that activates the 'Clips' section. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 34](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L34) | --- ### [all](#all) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.all ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) that will show "All" types of media. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 55](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L55) | --- ### [audio](#audio) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.audio ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) for the "Audio" filter. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 158](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L158) | --- ### [list](#list) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.list ` | | **Type** | Field | | **Description** | The list of clips as a [Table](cp.ui.OldTable.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L41) | --- ### [titles](#titles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.titles ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) for the "Titles" filter. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 165](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L165) | --- ### [type](#type) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.type ` | | **Type** | Field | | **Description** | The [IndexClips.Type](cp.apple.finalcutpro.timeline.IndexClips.Type.md). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 144](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L144) | --- ### [video](#video) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips.video ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) for the "Video" filter. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 151](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L151) | --- #### Methods ### [doFindAuditions](#dofindauditions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindAuditions() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will use the index to search for all "Auditions". | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 268](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L268) | --- ### [doFindClipsContaining](#dofindclipscontaining) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindClipsContaining(text) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.go.rx.Statement.md) that will use the index to search for clips containing the specified text. | | **Parameters** |
  • text - The text to search for.
| | **Returns** |
  • The [Statement](cp.rx.go.Statement.md)
| | **Notes** |
  • Because the `text` can change each time, this result is not cached automatically. However as long as you are searching for the same text the result can be safely cached. The [#toFindMissingMedia] method does this, for example.
| | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 232](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L232) | --- ### [doFindCompoundClips](#dofindcompoundclips) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindCompoundClips() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will use the index to search for all "Compound Clips". | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 294](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L294) | --- ### [doFindMissingMedia](#dofindmissingmedia) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindMissingMedia() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will use the index to search for all "Missing Media". | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 255](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L255) | --- ### [doFindMulticams](#dofindmulticams) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindMulticams() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will use the index to search for all "Multicam" clips. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 281](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L281) | --- ### [doFindSynchronized](#dofindsynchronized) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doFindSynchronized() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will use the index to search for all "Synchronized" Clips. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 307](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L307) | --- ### [doLayout](#dolayout) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips: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/IndexClips.lua line 339](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L339) | --- ### [doShowAll](#doshowall) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doShowAll() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will set the clip index to "All" media types. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 172](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L172) | --- ### [doShowAudio](#doshowaudio) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doShowAudio() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will set the clip index to "Audio" media types. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 202](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L202) | --- ### [doShowTitles](#doshowtitles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doShowTitles() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will set the clip index to "Titles" media types. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 217](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L217) | --- ### [doShowVideo](#doshowvideo) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips:doShowVideo() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | Returns a [Statement](cp.rx.go.Statement.md) that will set the clip index to "Video" media types. | | **Parameters** |
  • None
| | **Returns** |
  • A Statement
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 187](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L187) | --- ### [saveLayout](#savelayout) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.IndexClips: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/IndexClips.lua line 320](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua#L320) | --- ---