React Registry

hookPlayback Controls@techsquidtv/canvas-timeline-react/hooks

Playback Controls

Hooks for transport state, snapping, media synchronization, and clip playback effects.

7.0s

Playback controls preview

Transport, range, snapping, and viewport controls driven by focused editor hooks.

Open full demo

Installation

pnpm
pnpm add @techsquidtv/canvas-timeline-react
  1. 1

    Install the package.

    The command above adds the React bindings and their package dependencies.

  2. 2

    Import from the React entrypoint.

    @techsquidtv/canvas-timeline-react/hooks

Usage

Transport.tsx
import {
useTimelinePlayback,
useTimelineSnapping,
useTimelineViewport,
} from '@techsquidtv/canvas-timeline-react/hooks';
export function Transport() {
const playback = useTimelinePlayback();
const snapping = useTimelineSnapping();
const viewport = useTimelineViewport();
return (
<>
<button onClick={playback.togglePlayback}>
{playback.playing ? 'Pause' : 'Play'}
</button>
<button onClick={() => snapping.setEnabled(!snapping.enabled)}>
{snapping.enabled ? 'Snapping on' : 'Snapping off'}
</button>
<button onClick={() => viewport.setZoomScale(viewport.zoomScale - 50)}>Zoom out</button>
<button onClick={() => viewport.setZoomScale(viewport.zoomScale + 50)}>Zoom in</button>
</>
);
}

API Reference

Playback Controls

Hooks for transport state, snapping, media synchronization, and clip playback effects.

Exports

transport
NameReferenceDescription
useTimelinePlaybackAPI referenceReads playback state and exposes play, pause, rate, and toggle commands.
useTimelinePlayheadTimeAPI referenceSubscribes to the live playhead time for readouts and frame-sensitive buttons.
snapping
NameReferenceDescription
useTimelineSnappingAPI referenceReads snapping state and exposes threshold, feedback, and snap commands.
effects
NameReferenceDescription
usePlaybackEffectAPI referenceRuns effects as the playhead enters, updates, and leaves a clip.
media
NameReferenceDescription
useTimelineMediaSyncAPI referenceSynchronizes external media adapters to active timeline layers.
useTimelineMediaPlaybackAPI referenceControls media adapter playback state alongside the TimelineEngine.