Documentation Index
Fetch the complete documentation index at: https://mintlify.com/videojs/v10/llms.txt
Use this file to discover all available pages before exploring further.
Tracks media errors reported by the media element.
Import
import { error, selectError } from '@videojs/react';
// or
import { error, selectError } from '@videojs/html';
Usage
import { createPlayer, error } from '@videojs/react';
const Player = createPlayer({
features: [error],
});
import { createPlayer, error } from '@videojs/html';
const { ProviderMixin, PlayerController, context } = createPlayer({
features: [error],
});
State
The current media error object, or null when no error is present. The MediaError object includes a numeric code and a human-readable message.
Actions
Clear the current error, resetting error to null.
Selector
Use selectError to subscribe to only the error slice of 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, MediaElement, selectError } from '@videojs/html';
import { videoFeatures } from '@videojs/html/video';
const { PlayerController, context } = createPlayer({ features: videoFeatures });
class ErrorDisplay extends MediaElement {
readonly #error = new PlayerController(this, context, selectError);
}
Errors are set automatically by the media element. The only action available is dismissError() to clear the current error.
