cp.apple.finalcutpro.timeline.Contents.md

docs » cp.apple.finalcutpro.timeline.Contents

---

Timeline Contents Module.

API Overview

• Functions - API calls offered directly by the extension
• clipsUI
• playheadClipsUI
• Fields - Variables which can only be accessed from an object returned by a constructor
• children
• isFocused
• isLoaded
• playhead
• scrollArea
• scrollAreaUI
• selectedChildren
• skimmingPlayhead
• viewFrame
• Methods - API calls which can only be made on an object returned by a constructor
• doFocus
• doHide
• doSelectClip
• doSelectClips
• doShow
• rangeSelectionUI
• selectedClipsUI

API Documentation

Functions

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	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 axuielements that match the conditions

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
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 axuielements that match the conditions

Fields

children

Signature	cp.apple.finalcutpro.timeline.Contents.children <cp.prop: table; read-only; live>
Type	Field
Description	The current set of child elements in the Contents.

isFocused

Signature	cp.apple.finalcutpro.timeline.Contents.isFocused <cp.prop: booelan; read-only>
Type	Field
Description	Checks if the Timeline is currently the focused panel.

isLoaded

Signature	cp.apple.finalcutpro.timeline.Contents.isLoaded <cp.prop: booelan; read-only; live>
Type	Field
Description	Checks if the Timeline has content loaded.

playhead

Signature	cp.apple.finalcutpro.timeline.Contents.playhead <cp.apple.finalcutpro.main.Playhead>
Type	Field
Description	The main Playhead.

scrollArea

Signature	cp.apple.finalcutpro.timeline.Contents.scrollArea <cp.ui.ScrollArea>
Type	Field
Description	The ScrollArea for the Contents element.

scrollAreaUI

Signature	cp.apple.finalcutpro.timeline.Contents.scrollAreaUI <cp.prop: hs._asm.axuielement; read-only; live>
Type	Field
Description	The parent ScrollArea UI of the Timeline Contents area.

selectedChildren

Signature	cp.apple.finalcutpro.timeline.Contents.selectedChildren <cp.prop: table; read-only; live>
Type	Field
Description	The current set of selected child elements in the Contents.

skimmingPlayhead

Signature	cp.apple.finalcutpro.timeline.Contents.skimmingPlayhead <cp.apple.finalcutpro.main.Playhead>
Type	Field
Description	The Playhead that tracks with the mouse pointer.

viewFrame

Signature	cp.apple.finalcutpro.timeline.Contents.viewFrame <cp.prop: table; read-only; live>
Type	Field
Description	The current 'frame' of the internal timeline content, or nil if not available.

Methods

doFocus

Signature	cp.apple.finalcutpro.timeline.Contents:doFocus(show) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will focus on the Contents.
Parameters	show - if true, the Contents will be shown before focusing.
Returns	The Statement.

doHide

Signature	cp.apple.finalcutpro.timeline.Contents:doHide() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will attempt to hide the Timeline Contents.
Returns	The Statement.

doSelectClip

Signature	cp.apple.finalcutpro.timeline.Contents:doSelectClip(clipUI) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will select the specified single hs._asm.axuielement value in the Timeline Contents area.
Parameters	clipUI - The hs._asm.axuilement values to select.
Returns	A Statement that will select the clip or throw an error if there is an issue.

doSelectClips

Signature	cp.apple.finalcutpro.timeline.Contents:doSelectClips(clipsUI) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will select the specified list of hs._asm.axuielement values in the Timeline Contents area.
Parameters	clipsUI - The table of hs._asm.axuilement values to select.
Returns	A Statement that will select the clips or throw an error if there is an issue.

doShow

Signature	cp.apple.finalcutpro.timeline.Contents:doShow() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will attempt to show the Timeline Contents.
Returns	The Statement.

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

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