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.
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.
- srcrequiredstring | Array<IVideoSource>
- Media URL — either a single string for <video src>, or an array of source descriptors for codec fallback.
- posterstring
- Image rendered before playback starts. Maps to the native poster attribute when the #poster slot is not used.
- tracksArray<IVideoTrack>[]
- Captions / subtitles / chapter tracks attached to the player.
- autoplaybooleanfalse
- Starts playback as soon as loadedmetadata fires. Suppressed when the user has requested reduced motion.
- mutedbooleanfalse
- Starts the player muted.
- loopbooleanfalse
- Loops playback. The player restarts at 0 when ended fires.
- controlsTVideoControls'custom'
- Which control surface to render: custom, native, or none.
- playsInlinebooleantrue
- Mirrors the native playsinline attribute. Required on iOS to keep the player inside the page.
- preload'none' | 'metadata' | 'auto''metadata'
- Buffering hint.
- aspectRatiostring'16/9'
- CSS aspect-ratio value applied to the wrapper. Accepts presets or any raw value.
- crossoriginTCrossOrigin
- Mirrors the native crossorigin attribute. Required for canvas / WebAudio access.
- disablePictureInPicturebooleanfalse
- Disables the picture-in-picture button and keyboard shortcut.
- skipSecondsnumber30
- Seconds skipped by the ±skip buttons. Pass 0 to hide the skip buttons.
- showCenterControlsbooleantrue
- Show the centered ±skip buttons + play/pause overlay on hover.
- playbackRatesReadonlyArray<number>[0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2]
- Available playback rates exposed via the config menu.
- playbackRatenumber1
- Initial playback rate.
- insetbooleantrue
- Controls overlaid on the video bottom edge with auto-hide while playing.
- allowRemotePlaybackbooleantrue
- Enable the cast / AirPlay button (Remote Playback API).
- doubleTapToSkipbooleantrue
- Enable double-tap gestures on touch devices.
- downloadablebooleanfalse
- Adds a "Download" row to the settings menu.
- downloadFilenamestring
- 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