IMediaPlayerMethods

interface
Component Props

Imperative methods returned by useMediaPlayer. Media-agnostic subset — every method maps 1:1 to the standard HTMLMediaElement API. Video-specific commands (toggleFullscreen, togglePip) live in IVideoPlayerMethods.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

play
requis
() => Promise<void>
Resolve once el.play() has settled (or the call has been swallowed into state.error).
pause
requis
() => void
Pause playback. Returns synchronously.
toggle
requis
() => Promise<void>
Toggle between play and pause based on the current playing state.
seek
requis
(seconds: number) => void
Seek to seconds, clamped to [0, duration].
setVolume
requis
(value: number) => void
Set the volume, clamped to [0, 1]. Un-mutes when raising the volume from zero.
toggleMute
requis
() => void
Flip the muted flag on the element.
load
requis
() => void
Force a reload of the underlying media element.
skipBackward
requis
(seconds: number) => void
Jump backward by seconds, clamped to [0, duration].
skipForward
requis
(seconds: number) => void
Jump forward by seconds, clamped to [0, duration].
setPlaybackRate
requis
(rate: number) => void
Set the playback rate, clamped to [0.25, 4].
requestRemotePlayback
requis
() => Promise<void>
Open the native cast / AirPlay device picker. No-op when the Remote Playback API is unavailable.
stopRemotePlayback
requis
() => Promise<void>
Force-disconnect any active Remote Playback session. No-op when no session is active or the API is unavailable.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Calling methods from useMediaPlayer

typescript