Usage notes
Use this result for track lists, timeline sidebars, source-bin filters, and command bars that need to inspect or mutate the ordered track collection. For one row's DOM-ready state, use useTimelineTrack or useTimelineTrackHeader instead.
Signature
Interface UseTimelineTracksResultProperties
| Name | Signature | Description |
|---|---|---|
addTrack | (track: Track): TimelineCommandResult | Adds a track with owned, validated clip data. |
hiddenTracks | hiddenTracks: object[] | Tracks currently hidden from active layer and media lookup. |
moveTrack | (trackId: string, toIndex: number): TimelineCommandResult | Moves a track to its final zero-based row index. |
removeTrack | (trackId: string): TimelineCommandResult | Removes a track. |
renameTrack | (trackId: string, name: string | undefined): TimelineCommandResult | Renames a track, or clears its app-defined name. |
selectedTrack | selectedTrack: object | null | Currently selected track, or null when no track is selected. |
selectTrack | (trackId: string | null): TimelineCommandResult | Selects a track or clears track selection. |
setCollapsed | (trackId: string, collapsed: boolean): TimelineCommandResult | Sets row collapse while preserving expanded height and media visibility. |
setLocked | (trackId: string, locked: boolean): TimelineCommandResult | Sets the edit lock explicitly. |
setMuted | (trackId: string, muted: boolean): TimelineCommandResult | Sets track mute explicitly. |
setTrackGroup | (trackId: string, groupId: string | undefined): TimelineCommandResult | Sets or clears a track's group. |
setTrackHeight | (trackId: string, height: number): TimelineCommandResult | Sets expanded row height. |
setTrackTarget | (trackId: string, targeted: boolean): TimelineCommandResult | Sets edit targeting explicitly. |
setVisible | (trackId: string, visible: boolean): TimelineCommandResult | Sets track output visibility explicitly. |
targetedTracks | targetedTracks: object[] | Tracks currently targeted for edit operations. |
toggleCollapse | (trackId: string): TimelineCommandResult | Toggles row collapse using the current track state. |
toggleLock | (trackId: string): TimelineCommandResult | Toggles the edit lock. |
toggleMute | (trackId: string): TimelineCommandResult | Toggles track mute. |
toggleTrackTarget | (trackId: string): TimelineCommandResult | Toggles edit targeting. |
toggleVisibility | (trackId: string): TimelineCommandResult | Toggles track output visibility. |
tracks | tracks: typeOperator | Current ordered track list. |
tracksByGroupId | tracksByGroupId: Record<string, TimelineReadonly<Track>[]> | Tracks grouped by group id, with ungrouped tracks under "ungrouped". |
visibleTracks | visibleTracks: object[] | Tracks currently participating in active layer and media lookup. |