IVideoScopedSlotBindings

interface
Component Slots

Bindings passed to the #controls scoped slot of OrigamVideo. The default toolbar is built on top of the exact same surface, so a consumer who replaces the slot has access to the full state machine without re-implementing event listeners.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

playing
required
boolean
True while the <video> is decoding frames and producing audio.
paused
required
boolean
True when playback is paused (or has not started yet).
currentTime
required
number
Current playhead position in seconds.
duration
required
number
Total duration in seconds. NaN until metadata is loaded.
buffered
required
number
End of the buffered range in seconds.
volume
required
number
Volume between 0 and 1 — independent from muted.
muted
required
boolean
True when the output is muted. Independent from volume.
fullscreen
required
boolean
True when the element (or wrapper) is in fullscreen.
pip
required
boolean
True when the video is in picture-in-picture.
loading
required
boolean
True between loadstart and loadedmetadata — used by the loader overlay.
error
required
MediaError | Error | null
Set to the most recent media error (if any), else null.
playbackRate
required
number
Current playback rate (1 = normal).
remoteAvailable
required
boolean
True when at least one Remote Playback target is available on the network.
remoteState
required
'disconnected' | 'connecting' | 'connected'
Connection lifecycle from the Remote Playback API.
methods
required
IVideoPlayerMethods
Imperative actions — wired to the underlying <video> element.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Rendering a custom controls bar with scoped slot bindings

html