Error

Media error state and actions for the player store

Tracks media errors.

Import

import { errorFeature } from '@videojs/html';

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

API Reference

State

Property	Type	Details
`error`	`{ code: number; message: string } \| null`
Description The current media error, or null if none.

Actions

Action	Type	Details
`dismissError`	`() => void`
Description Dismiss the current error by clearing it.

Selector

Pass selectError to PlayerController to subscribe to error state. Returns undefined if the error feature is not configured.

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

function ErrorDisplay() {
  const err = usePlayer(selectError);
  if (!err?.error) return null;

  return (
    <div>
      <p>{err.error.message}</p>
      <button onClick={err.dismissError}>Dismiss</button>
    </div>
  );
}

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

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

class ErrorDisplay extends UIElement {
  readonly #error = new PlayerController(this, selectError);
}