UseHTMLTimelineMediaResult (html-media-adapter) API

Signature

Interface UseHTMLTimelineMediaResult

Name	Constraint	Default	Description
`LayerName`	`string`	`string`

Name	Signature	Description
`activeLayers`	`activeLayers: ActiveLayerResult<LayerName>`	Active layers at the current playhead time.
`adapter`	`adapter: HTMLMediaAdapter`	Underlying imperative HTML media adapter.
`element`	`element: HTMLMediaElement \| null`	Currently connected native media element.
`mediaRef`	`mediaRef: RefCallback<HTMLMediaElement>`	Stable callback ref that connects the native media element to the adapter.
`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.
`ready`	`ready: boolean`	Whether a native media element is connected; inspect source state for native loading.
`setPlaybackRate`	`(playbackRate: number): Promise<TimelineCommandResult>`	Updates both clock rates and resolves after active layers resynchronize.
`sourceStateById`	`sourceStateById: ReadonlyMap<string, HTMLMediaSourceState>`	Immutable native loading, fallback-attempt, and failure snapshot by source id.