Canvas Timeline
Interface

UseTimelineTracksResult

Result returned by `useTimelineTracks`.

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

Type Definition
Interface UseTimelineTracksResult

Type parameters

NameConstraintDefaultDescription
TrackKindNonestringApp-defined track kind values carried by returned tracks, such as `"visual" | "audio"`.

Properties

NameSignatureDescription
addTrack(track: Track<TrackKind>): TimelineCommandResultAdds a track to the timeline.
hiddenTrackshiddenTracks: Track<TrackKind>[]Tracks currently hidden from active layer and media lookup.
removeTrack(trackId: string): TimelineCommandResultRemoves a track from the timeline.
selectedTrackselectedTrack: Track<TrackKind> | nullCurrently selected track, or null when no track is selected.
selectTrack(trackId: string | null): TimelineCommandResultSelects a track by id, or clears track selection.
setTrackGroup(trackId: string, groupId: string | undefined): TimelineCommandResultAssigns a track to a group, or clears its group.
setTrackHeight(trackId: string, height: number): TimelineCommandResultSets a track's expanded display height in pixels.
targetedTrackstargetedTracks: Track<TrackKind>[]Tracks currently targeted for edit operations.
toggleLock(trackId: string, locked?: boolean): TimelineCommandResultSets or toggles whether a track is locked.
toggleMute(trackId: string, muted?: boolean): TimelineCommandResultSets or toggles whether a track is muted.
toggleTrackTarget(trackId: string, targeted?: boolean): TimelineCommandResultSets or toggles whether a track is targeted for edit operations.
toggleVisibility(trackId: string, visible?: boolean): TimelineCommandResultSets or toggles whether a track participates in active layer and media lookup.
trackstracks: Track<TrackKind>[]Current ordered track list.
tracksByGroupIdtracksByGroupId: Record<string, Track<TrackKind>[]>Tracks grouped by group id, with ungrouped tracks under "ungrouped".
visibleTracksvisibleTracks: Track<TrackKind>[]Tracks currently participating in active layer and media lookup.

Related links