UseMediabunnyTimelineMediaResult (mediabunny-adapter) API

Signature

Interface UseMediabunnyTimelineMediaResult

Name	Constraint	Default	Description
`LayerName`	`string`	`string`	Named media layer keys from UseMediabunnyTimelineMediaOptions.layers.

Name	Signature	Description
`activeLayers`	`activeLayers: ActiveLayerResult<LayerName>`	Active layers at the current playhead time.
`adapter`	`adapter: MediabunnyAdapter`	Underlying low-level Mediabunny adapter.
`canvas`	`canvas: HTMLCanvasElement \| null`	Currently connected preview canvas.
`canvasRef`	`canvasRef: RefCallback<HTMLCanvasElement>`	Stable callback ref that connects the preview canvas to the adapter.
`error`	`error: Error \| null`	Last source loading error, when one is active.
`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 at least one Mediabunny source is registered for lazy loading.
`setPlaybackRate`	`(playbackRate: number): Promise<TimelineCommandResult>`	Updates both clock rates and resolves after active layers resynchronize.
`sourceStateById`	`sourceStateById: ReadonlyMap<string, MediabunnySourceState>`	Loading, input attempts, metadata, and recovery by source id.
`status`	`status: string`	Human-readable loading, playback, or error status.