Interface

UseTimelineSelectionResult

Result returned by `useTimelineSelection`.

Signature

Type Definition
Interface UseTimelineSelectionResult

Type parameters

NameConstraintDefaultDescription
TrackKindNonestringNo type parameter summary yet.

Properties

NameSignatureDescription
clearSelection(): voidClears both clip and track selection.
selectClip(clipId: string | null): voidSelects a clip by id, or clears clip selection when passed null.
selectedClipselectedClip: Clip | nullCurrently selected clip, or null when no clip is selected.
selectedClipIdselectedClipId: string | nullID of the currently selected clip, or null when no clip is selected.
selectedClipTrackIdselectedClipTrackId: string | nullID of the track containing the selected clip, or null when no clip is selected.
selectedTrackselectedTrack: Track<TrackKind> | nullCurrently selected track, or null when no track row is selected.
selectedTrackIdselectedTrackId: string | nullID of the currently selected track, or null when no track row is selected.
selectTrack(trackId: string | null): voidSelects a track by id, or clears track selection when passed null.