IVideoProps

interface
Component Props

Props for OrigamVideo. Extends the standard DS visual interfaces (color, dimension, rounded, border, margin, padding, elevation) with media-specific controls: src, poster, tracks, autoplay, loop, aspect-ratio, fullscreen, PIP, skip, quality switching, and download.

TypeScript

Definition

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

typescript

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.

src
required
string | Array<IVideoSource>
Media URL — either a single string for <video src>, or an array of source descriptors for codec fallback.
poster
string
Image rendered before playback starts. Maps to the native poster attribute when the #poster slot is not used.
tracks
Array<IVideoTrack>
[]
Captions / subtitles / chapter tracks attached to the player.
autoplay
boolean
false
Starts playback as soon as loadedmetadata fires. Suppressed when the user has requested reduced motion.
muted
boolean
false
Starts the player muted.
loop
boolean
false
Loops playback. The player restarts at 0 when ended fires.
controls
TVideoControls
'custom'
Which control surface to render: custom, native, or none.
playsInline
boolean
true
Mirrors the native playsinline attribute. Required on iOS to keep the player inside the page.
preload
'none' | 'metadata' | 'auto'
'metadata'
Buffering hint.
aspectRatio
string
'16/9'
CSS aspect-ratio value applied to the wrapper. Accepts presets or any raw value.
crossorigin
TCrossOrigin
Mirrors the native crossorigin attribute. Required for canvas / WebAudio access.
disablePictureInPicture
boolean
false
Disables the picture-in-picture button and keyboard shortcut.
skipSeconds
number
30
Seconds skipped by the ±skip buttons. Pass 0 to hide the skip buttons.
showCenterControls
boolean
true
Show the centered ±skip buttons + play/pause overlay on hover.
playbackRates
ReadonlyArray<number>
[0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2]
Available playback rates exposed via the config menu.
playbackRate
number
1
Initial playback rate.
inset
boolean
true
Controls overlaid on the video bottom edge with auto-hide while playing.
allowRemotePlayback
boolean
true
Enable the cast / AirPlay button (Remote Playback API).
doubleTapToSkip
boolean
true
Enable double-tap gestures on touch devices.
downloadable
boolean
false
Adds a "Download" row to the settings menu.
downloadFilename
string
Override the downloaded file name.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Basic OrigamVideo usage

html