Usage notes
The result is scoped to one track row and includes both state flags and
row-level commands. It also includes `rect`, which is aligned with canvas
track geometry for DOM overlays, resize handles, and track header layouts.
Signature
Interface UseTimelineTrackResultProperties
| Name | Signature | Description |
|---|---|---|
collapsed | collapsed: boolean | Whether the track row is collapsed. |
exists | exists: boolean | Whether the requested track exists. |
groupId | groupId: string | undefined | Optional track group id. |
height | height: number | Expanded row height in pixels, matching canvas geometry. |
kind | kind: string | null | App-defined track kind, or null when the track is missing. |
locked | locked: boolean | Whether the track is locked for editing. |
moveTrack | (toIndex: number): TimelineCommandResult | Moves this track to a final zero-based row index. |
muted | muted: boolean | Whether the track is muted. |
name | name: string | undefined | User-facing track name, when set. |
rect | rect: Readonly<TimelineTrackRect> | null | Viewport row rectangle matching canvas track geometry. |
renameTrack | (name: string | undefined): TimelineCommandResult | Renames this track, or clears its app-defined name. |
selected | selected: boolean | Whether the track itself is selected. |
selectTrack | (): TimelineCommandResult | Selects this track. |
setCollapsed | (collapsed: boolean): TimelineCommandResult | Sets this row's collapsed state. |
setLocked | (locked: boolean): TimelineCommandResult | Sets this track's locked state. |
setMuted | (muted: boolean): TimelineCommandResult | Sets this track's muted state. |
setTrackGroup | (groupId: string | undefined): TimelineCommandResult | Assigns this track to a group, or clears its group. |
setTrackHeight | (height: number): TimelineCommandResult | Sets this track's expanded display height in pixels. |
setTrackTarget | (targeted: boolean): TimelineCommandResult | Sets this track's edit-targeted state. |
setVisible | (visible: boolean): TimelineCommandResult | Sets this track's output visibility. |
targeted | targeted: boolean | Whether the track is targeted for edit operations. |
toggleCollapse | (): TimelineCommandResult | Toggles this row's collapsed state. |
toggleLock | (): TimelineCommandResult | Toggles this track's locked state. |
toggleMute | (): TimelineCommandResult | Toggles this track's muted state. |
toggleTrackTarget | (): TimelineCommandResult | Toggles this track's edit-targeted state. |
toggleVisibility | (): TimelineCommandResult | Toggles this track's output visibility. |
track | track: object | null | Current track, or null when the id is missing. |
trackId | trackId: string | Requested track id. |
trackIndex | trackIndex: number | Zero-based track index, or -1 when the track is missing. |
visible | visible: boolean | Whether the track participates in active layer and media lookup. |