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.
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.
- playrequis() => Promise<void>
- Resolve once el.play() has settled (or the call has been swallowed into state.error).
- pauserequis() => void
- Pause playback. Returns synchronously.
- togglerequis() => Promise<void>
- Toggle between play and pause based on the current playing state.
- seekrequis(seconds: number) => void
- Seek to seconds, clamped to [0, duration].
- setVolumerequis(value: number) => void
- Set the volume, clamped to [0, 1]. Un-mutes when raising the volume from zero.
- toggleMuterequis() => void
- Flip the muted flag on the element.
- loadrequis() => void
- Force a reload of the underlying media element.
- skipBackwardrequis(seconds: number) => void
- Jump backward by seconds, clamped to [0, duration].
- skipForwardrequis(seconds: number) => void
- Jump forward by seconds, clamped to [0, duration].
- setPlaybackRaterequis(rate: number) => void
- Set the playback rate, clamped to [0.25, 4].
- requestRemotePlaybackrequis() => Promise<void>
- Open the native cast / AirPlay device picker. No-op when the Remote Playback API is unavailable.
- stopRemotePlaybackrequis() => 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