Usage notes
These commands operate on the timeline engine and resolve TimelineCommandResult values so toolbar code can show disabled, content-gap, invalid-input, or synchronization feedback without reading private engine state. Playback and rate changes await serialized adapter synchronization before resolving.
Signature
Interface UseTimelineMediaPlaybackResultProperties
| Name | Signature | Description |
|---|---|---|
pause | (): TimelineCommandResult | Stops timeline playback and synchronizes external media into a paused state. |
play | (): Promise<TimelineCommandResult> | Starts playback after active external layers finish synchronizing. |
playbackRate | playbackRate: number | Current timeline playback speed multiplier. |
playing | playing: boolean | Whether the timeline engine is currently playing against the external clock. |
setPlaybackRate | (rate: number): Promise<TimelineCommandResult> | Updates both clocks and resolves after active layers resynchronize. |