Interface

UseTimelineMediaSyncResult

Result returned by `useTimelineMediaSync`.

Signature

Type Definition
Interface UseTimelineMediaSyncResult

Type parameters

NameConstraintDefaultDescription
LayerNamestringstringNo type parameter summary yet.

Properties

NameSignatureDescription
activeLayersactiveLayers: ActiveLayerResult<LayerName>Active layers at the current playhead time.
pause(): TimelineCommandResultStops synchronized timeline/media playback and pauses external media state.
play(): Promise<TimelineMediaPlayResult>Starts external media playback and then advances the timeline from that clock.
playbackRateplaybackRate: numberCurrent synchronized playback speed multiplier.
playingplaying: booleanWhether synchronized timeline and external media playback is currently running.
setPlaybackRate(playbackRate: number): TimelineCommandResultUpdates both the external clock rate and the timeline playback rate.