API Reference

@techsquidtv/canvas-timeline-mediabunny-adapter

packages/mediabunny-adapter/src/index.ts

Common Entry Points

Start with these essential APIs, then check the full reference index below.

Function

useMediabunnyTimelineMedia

Create a Mediabunny adapter and bind it to timeline-synchronized playback.

Function

createMediabunnyAdapter

Create a Mediabunny adapter that drives Canvas Timeline media playback.

Function

useMediabunnyAdapter

Create and dispose a Mediabunny timeline adapter from React state.

Interface

MediabunnyAdapter

Adapter that connects Canvas Timeline playback and frame rendering to Mediabunny.

API Index

Exhaustive list of all public exports grouped by category.

Interface

CreateMediabunnyAdapterOptions

Options for creating a Mediabunny-backed timeline media sync adapter.

MediabunnyAdapter

Adapter that connects Canvas Timeline playback and frame rendering to Mediabunny.

MediabunnyAudioMetadata

Audio metadata for the selected source track.

MediabunnyFrame

Decoded video frame returned from a Mediabunny canvas sink.

MediabunnySourceMetadata

Timing and selected-track metadata for a loaded source.

MediabunnySourceState

Observable loading and recovery state for a logical source.

MediabunnyTimelineAudioOptions

Web Audio options used when Mediabunny drives timeline audio playback.

MediabunnyTrackSelection

Tracks selected from a loaded resolved source input.

MediabunnyTrackSelectionContext

Context passed to custom media-track selection.

MediabunnyVideoMetadata

Video metadata for the selected source track.

UseMediabunnyAdapterOptions

Options for creating a Mediabunny adapter from React.

UseMediabunnyTimelineMediaOptions

Options for wiring Mediabunny decoded preview directly to timeline playback.

UseMediabunnyTimelineMediaResult

Timeline transport state plus Mediabunny preview status and adapter details.

Type Alias

MediabunnyAudioStatus

Current availability of the adapter's optional Web Audio graph.

MediabunnyModule

Runtime shape of the Mediabunny module used by the timeline adapter.

MediabunnySource

One app-resolved media choice for a logical timeline source.

MediabunnySourceInput

Media asset descriptor that tells the adapter how to open a timeline source.

Function

createMediabunnyAdapter

Create a Mediabunny adapter that drives Canvas Timeline media playback.

formatMediabunnyTime

Format a timeline or source-media time value for Mediabunny adapter status text.

useMediabunnyAdapter

Create and dispose a Mediabunny timeline adapter from React state.

useMediabunnyFrameTime

Subscribe to the latest decoded preview frame without re-rendering ordinary media consumers.

useMediabunnyTimelineMedia

Create a Mediabunny adapter and bind it to timeline-synchronized playback.