# cp.apple.finalcutpro.timeline.Toolbar Timeline Toolbar --- ## Submodules * [cp.apple.finalcutpro.timeline.Toolbar.Browser](cp.apple.finalcutpro.timeline.Toolbar.Browser.md) * [cp.apple.finalcutpro.timeline.Toolbar.Clip](cp.apple.finalcutpro.timeline.Toolbar.Clip.md) --- ## API Overview **Functions** - _API calls offered directly by the extension_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [Toolbar](#toolbar) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [appearance](#appearance) * [appearanceToggle](#appearancetoggle) * [appendClip](#appendclip) * [audioSkimming](#audioskimming) * [back](#back) * [browser](#browser) * [clip](#clip) * [clipMedia](#clipmedia) * [duration](#duration) * [effects](#effects) * [forward](#forward) * [index](#index) * [insertClip](#insertclip) * [overwriteClip](#overwriteclip) * [skimming](#skimming) * [snapping](#snapping) * [solo](#solo) * [title](#title) * [tool](#tool) * [transitions](#transitions) * [trimAlignedEdges](#trimalignededges) --- ## API Documentation #### Functions ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks if the element is a Toolbar. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 30](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L30) | --- #### Constructors ### [Toolbar](#toolbar) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar(timeline) -> cp.apple.finalcutpro.timeline.Toolbar` | | **Type** | Constructor | | **Description** | Creates a new Toolbar with the specified parent. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 43](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L43) | --- #### Fields ### [appearance](#appearance) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.appearance ` | | **Type** | Field | | **Description** | The [Appearance](cp.apple.finalcutpro.timeline.Appearance.md) button/palette control. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 242](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L242) | --- ### [appearanceToggle](#appearancetoggle) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.appearanceToggle ` | | **Type** | Field | | **Description** | A `CheckBox` field which will toggle the `appearance` popover. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 231](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L231) | --- ### [appendClip](#appendclip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.appendClip ` | | **Type** | Field | | **Description** | The [Button](cp.ui.Button.md) which appends a clip from the Browser into the Timeline. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 101](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L101) | --- ### [audioSkimming](#audioskimming) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.audioSkimming ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) that indicates if audio is played while skimming. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 219](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L219) | --- ### [back](#back) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.back ` | | **Type** | Field | | **Description** | The [Button](cp.ui.Button.md) for "go back in timeline history". | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 147](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L147) | --- ### [browser](#browser) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.browser ` | | **Type** | Field | | **Description** | The [Toolbar.Browser](cp.apple.finalcutpro.timeline.Toolbar.Browser.md) containing buttons that will toggle the Effects/Transitions browsers. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 249](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L249) | --- ### [clip](#clip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.clip ` | | **Type** | Field | | **Description** | The [Clip](cp.apple.finalcutpro.timeline.Toolbar.Clip.md) group of checkbox items. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 196](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L196) | --- ### [clipMedia](#clipmedia) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.clipMedia ` | | **Type** | Field | | **Description** | The [MenuButton](cp.ui.MenuButton.md) which allows the user to select the media type that will | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 123](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L123) | --- ### [duration](#duration) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.duration ` | | **Type** | Field | | **Description** | The [StaticText](cp.ui.StaticText.md) which displays the duration of the Timeline. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 171](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L171) | --- ### [effects](#effects) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.effects ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) which toggles the 'Effects' browser visibility. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 260](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L260) | --- ### [forward](#forward) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.forward ` | | **Type** | Field | | **Description** | The [Button](cp.ui.Button.md) for "go forward in timeline history". | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 185](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L185) | --- ### [index](#index) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.index ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) which indicates if the Timeline Index is visible. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 68](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L68) | --- ### [insertClip](#insertclip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.insertClip ` | | **Type** | Field | | **Description** | The [Button](cp.ui.Button.md) which inserts a clip from the Browser into the Timeline. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 90](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L90) | --- ### [overwriteClip](#overwriteclip) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.overwriteClip ` | | **Type** | Field | | **Description** | The [Button](cp.ui.Button.md) which overwrites a clip from the Browser into the Timeline. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 112](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L112) | --- ### [skimming](#skimming) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.skimming ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) that indicates if video/audio skimming is active. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 215](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L215) | --- ### [snapping](#snapping) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.snapping ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) that indicates if snapping is enabled. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 227](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L227) | --- ### [solo](#solo) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.solo ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) that indicates if audio is soloed on the selected clip(s). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 223](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L223) | --- ### [title](#title) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.title ` | | **Type** | Field | | **Description** | The [MenuButton](cp.ui.MenuButton.md) which lists the current project and allows | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 158](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L158) | --- ### [tool](#tool) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.tool ` | | **Type** | Field | | **Description** | The [ToolPalette](cp.apple.finalcutpro.timeline.ToolPalette.md), which allows the user to select the tool | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 135](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L135) | --- ### [transitions](#transitions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.transitions ` | | **Type** | Field | | **Description** | The [RadioButton](cp.ui.RadioButton.md) which toggles the 'Transitions' browser visibility. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 264](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L264) | --- ### [trimAlignedEdges](#trimalignededges) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.timeline.Toolbar.trimAlignedEdges ` | | **Type** | Field | | **Description** | The [CheckBox](cp.ui.CheckBox.md) which allows the user to trim the edges of the selected clips. | | **Notes** |
  • As of FCP 10.6.3, this is currently always hidden, and cannot have its value changed.
  • Uncertain in exactly which version this turned up.
| | **Source** | [src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua line 207](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/timeline/Toolbar.lua#L207) | --- ---