Skip to content

ReferenceFeatures

Playback

Play/pause state and actions for the player store

Controls play/pause state and tracks whether playback has started or is stalled.

Import

import { playbackFeature } from '@videojs/react';

The audioFeatures, liveAudioFeatures, liveVideoFeatures, and videoFeatures feature bundles include this feature.

API Reference

State

PropertyTypeDetails
pausedboolean
endedboolean
startedboolean
waitingboolean

Actions

ActionTypeDetails
playfunction
pausefunction
togglePausedfunction

Selector

Pass selectPlayback to usePlayer to subscribe to playback state. Returns undefined if the playback feature is not configured.

import { selectPlayback, usePlayer } from '@videojs/react';

function PlayButton() {
  const playback = usePlayer(selectPlayback);
  if (!playback) return null;
  return <button onClick={playback.togglePaused}>{playback.paused ? 'Play' : 'Pause'}</button>;
}