Usage notes
Use the commands in this result for media-aware transport controls. The
`activeLayers` snapshot is useful for custom status panels, preview badges,
and adapter diagnostics.
Signature
Interface UseTimelineMediaSyncResultType parameters
| Name | Constraint | Default | Description |
|---|---|---|---|
LayerName | string | string | Named media layer keys from UseTimelineMediaSyncOptions.layers. |
Properties
| Name | Signature | Description |
|---|---|---|
activeLayers | activeLayers: ActiveLayerResult<LayerName> | Active layers at the current playhead time. |
pause | (): TimelineCommandResult | Stops synchronized timeline/media playback and pauses external media state. |
play | (): Promise<TimelineMediaPlayResult> | Starts external media playback and then advances the timeline from that clock. |
playbackRate | playbackRate: number | Current synchronized playback speed multiplier. |
playing | playing: boolean | Whether synchronized timeline and external media playback is currently running. |
setPlaybackRate | (playbackRate: number): TimelineCommandResult | Updates both the external clock rate and the timeline playback rate. |