IUseVideoPlayerOptions
interface
Composable Options
Options accepted by useVideoPlayer. Extends the media-agnostic IUseMediaPlayerOptions shape (minus mediaRef) and adds a videoRef so the composable can be wired from outside an OrigamVideo host.
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.
- videoRefRef<HTMLVideoElement | null>
- Resolves to the HTMLVideoElement to drive. When omitted, the composable creates an empty ref and expects the consumer to bind it on a <video ref> themselves.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Wiring useVideoPlayer to a <video> element