IVideoPlayerMethods
interface
Composable Returns
Imperative methods returned by useVideoPlayer. Extends the media-shared baseline IMediaPlayerMethods with video-specific commands: toggleFullscreen, togglePip, and related enter/exit variants.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- enterFullscreenrequired() => Promise<void>
- Enter fullscreen (or noop if already in).
- exitFullscreenrequired() => Promise<void>
- Exit fullscreen (or noop if not in).
- toggleFullscreenrequired() => Promise<void>
- Convenience: enter or exit based on current state.
- requestPiprequired() => Promise<void>
- Enter picture-in-picture (or noop if unsupported).
- exitPiprequired() => Promise<void>
- Exit picture-in-picture (or noop if not in).
- togglePiprequired() => Promise<void>
- Convenience: enter or exit PIP based on current state.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Using video-specific methods from useVideoPlayer