useMediabunnyAdapter API

Usage notes

Use this hook when your app wants to manage transport with useTimelineMediaSync manually, inspect decoded frame state, or share one adapter across custom preview controls. For a ready-made transport hook, use useMediabunnyTimelineMedia.

Signature

useMediabunnyAdapter(options: UseMediabunnyAdapterOptions): MediabunnyAdapter

Parameters

Name	Type	Description
options	UseMediabunnyAdapterOptions	Mediabunny sources, optional canvas ref, audio options, and module loader.

Returns

MediabunnyAdapter

The current Mediabunny adapter, including readiness, status, decoded frame state, and sync callbacks.

Examples

import { useMemo, useRef } from 'react';
import { useMediabunnyAdapter } from '#mediabunny-adapter/react';

export function DecoderStatus() {
  const canvasRef = useRef<HTMLCanvasElement>(null);
  const sources = useMemo(() => [{ id: 'source-1', url: '/media/sample.mp4' }], []);
  const adapter = useMediabunnyAdapter({ canvasRef, sources });

  return (
    <>
      <canvas ref={canvasRef} width={1280} height={720} />
      <p>{adapter.status}</p>
    </>
  );
}

- MediabunnyAdapter - useMediabunnyTimelineMedia