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/html';

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

API Reference

State

Property	Type	Details
`paused`	`boolean`
Description Whether playback is paused.
`ended`	`boolean`
Description Whether playback has reached the end.
`started`	`boolean`
Description Whether playback has started (played or seeked).
`waiting`	`boolean`
Description Whether playback is stalled waiting for data.

Actions

Action	Type	Details
`play`	`function`
Description Start playback. Type `() => Promise<void>`
`pause`	`function`
Description Pause playback. Type `() => void`
`togglePaused`	`function`
Description Toggle play/pause. Returns `true` if playback started. Type `() => boolean`

Selector

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

import { createPlayer, UIElement, selectPlayback } from '@videojs/html';
import { videoFeatures } from '@videojs/html/video';

const { PlayerController } = createPlayer({ features: videoFeatures });

class PlayButton extends UIElement {
  readonly #playback = new PlayerController(this, selectPlayback);
}