useVideoPlayer

Video
stable

Headless video player composable. Composes the media-shared useMediaPlayer base and adds video-only state (fullscreen, pip) plus methods (enterFullscreen, exitFullscreen, toggleFullscreen, requestPip, exitPip, togglePip). Handles the iOS Safari webkitEnterFullscreen fallback and the document-level fullscreenchange listener.

API

Signature

Signature TypeScript complète extraite du fichier du composable.

typescript

useVideoPlayer adds video-only APIs on top of useMediaPlayer. The fullscreen implementation falls back to `webkitEnterFullscreen` on iOS Safari. PIP uses the standard `requestPictureInPicture` API and silently no-ops on browsers that do not support it (Firefox desktop).

Interfaces consommées

IUseVideoPlayerOptions
IVideoPlayerState
IVideoPlayerMethods

API

Paramètres

Paramètres d'entrée acceptés par ce composable.

options
IUseVideoPlayerOptions
{}
Accepts `videoRef` (bring your own typed ref), `autoplay`, `muted`, `loop`, `preload`. All optional. Autoplay is suppressed when prefers-reduced-motion is active.

API

Valeurs de retour

Propriétés et méthodes exposées par l'objet retourné par le composable.

videoRef
Template ref to bind to the `<video>` element. Reused from `options.videoRef` when provided.
state
All IMediaPlayerState fields (playing, paused, currentTime, duration, buffered, volume, muted, ready, loading, error, playbackRate, remoteAvailable, remoteState) plus `fullscreen: Ref<boolean>` and `pip: Ref<boolean>`.
methods
All IMediaPlayerMethods (play, pause, toggle, seek, setVolume, toggleMute, load, skipBackward, skipForward, setPlaybackRate, requestRemotePlayback, stopRemotePlayback) plus `enterFullscreen`, `exitFullscreen`, `toggleFullscreen`, `requestPip`, `exitPip`, `togglePip`.

Usage

Exemples

Extraits de code prêts à coller.

Custom video player with fullscreen and PIP

vue

Using OrigamVideo (recommended)

vue