Fullscreen

Fullscreen state and actions for the player store

Controls fullscreen mode. Tries the container element first, falls back to the media element.

API Reference

State

Property	Type	Details
`fullscreen`	`boolean`
Description Whether fullscreen mode is currently active.
`fullscreenAvailability`	`'available' \| 'unavailable' \| 'unsupported'`
Description Whether fullscreen can be requested on this platform.

Actions

Action	Type	Details
`requestFullscreen`	`() => Promise<void>`
Description Enter fullscreen mode. Tries container first, falls back to media element.
`exitFullscreen`	`() => Promise<void>`
Description Exit fullscreen mode.

Selector

Pass selectFullscreen to PlayerController to subscribe to fullscreen state. Returns undefined if the fullscreen feature is not configured.

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

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

class FullscreenButton extends MediaElement {
  readonly #fullscreen = new PlayerController(this, context, selectFullscreen);
}