Canvas Timeline
Interface

UseTimelineMarkersResult

Result returned by `useTimelineMarkers`.

Signature

Type Definition
Interface UseTimelineMarkersResult

Properties

NameSignatureDescription
addMarker(time: RationalTime, label?: string, color?: string, description?: string): TimelineCommandResult<Marker>Adds a marker at a timeline time.
addMarkerAtPlayhead(label?: string, color?: string, description?: string): TimelineCommandResult<Marker>Adds a marker at the current playhead.
markersmarkers: Marker[]Current timeline markers sorted by time.
removeMarker(id: string): TimelineCommandResultRemoves a marker by id.
seekToMarker(id: string): TimelineCommandResult<Marker>Moves the playhead to a marker by id.
seekToNextMarker(): TimelineCommandResult<Marker>Moves the playhead to the next marker after the current playhead.
seekToPreviousMarker(): TimelineCommandResult<Marker>Moves the playhead to the previous marker before the current playhead.
updateMarker(id: string, updates: TimelineMarkerUpdate): TimelineCommandResult<Marker>Updates marker metadata by id.