Cast

Cast state and actions for the player store

Controls casting to remote playback devices (e.g. Chromecast). Exits fullscreen before initiating a cast session.

API Reference

State

Property	Type	Details
`castState`	`'disconnected' \| 'connecting' \| 'connected'`
Description Current cast connection state.
`castAvailability`	`'available' \| 'unavailable' \| 'unsupported'`
Description Whether casting can be requested on this platform.

Actions

Action	Type	Details
`toggleCast`	`() => Promise<void>`
Description Toggle cast connection.

Selector

Pass selectCast to PlayerController to subscribe to cast state. Returns undefined if the cast feature is not configured.

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

function CastButton() {
  const cast = usePlayer(selectCast);
  if (!cast || cast.castAvailability !== 'available') return null;

  return (
    <button onClick={cast.toggleCast}>
      {cast.castState === 'connected' ? 'Disconnect' : 'Cast'}
    </button>
  );
}

import { createPlayer, MediaElement, selectCast } from '@videojs/html';
import { videoFeatures } from '@videojs/html/video';

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

class CastButton extends MediaElement {
  readonly #cast = new PlayerController(this, context, selectCast);
}