Interface: VideoOptions
Configuration options for the Video component.
Extends
Properties
| Property | Type | Description |
|---|---|---|
align? | Align | - |
blur? | number | Blur in virtual pixels (default: 0). |
brightness? | number | Brightness multiplier (default: 1). |
className? | string | - |
color? | string | Foreground CSS color (default: component/theme color). |
controls? | boolean | Whether to show native browser video controls. Defaults to false. |
currentTime? | number | Initial or target playback position in seconds. |
customPositioned? | boolean | Whether this element manages its own CSS transform / positioning (disables stage translate3d). |
enterDelay? | number | Delay in seconds before entering scene transition begins. |
enterDuration? | number | Duration in seconds for entering scene transition. |
exitDelay? | number | Delay in seconds before exiting scene transition begins. |
exitDuration? | number | Duration in seconds for exiting scene transition. |
fit? | ImageFit | Sizing fit: "contain" (default) |
height? | Size | Height in stage units or CSS length (default: content size). |
id? | string | - |
interactive? | boolean | Whether clicking the video toggles play/pause interactively. Defaults to true when controls is false. |
loop? | boolean | Whether the video loops automatically when reaching the end. Defaults to false. |
muted? | boolean | Whether audio track is muted. Defaults to true (required for browser autoplay). |
onActivate? | () => void | - |
onDeactivate? | () => void | - |
onMount? | () => void | - |
onUnmount? | () => void | - |
opacity? | number | Whole-element opacity from 0 to 1 (default: 1). |
origin? | ElementAnchor | Which point of the element sits on its coordinate (default: "top-left"). |
playbackRate? | number | Playback speed multiplier (e.g. 1.0, 1.5, 2.0). Defaults to 1.0. |
playing? | boolean | Whether the video is currently playing. Defaults to false. |
position? | Position | - |
preload? | "metadata" | "none" | "auto" | Preload policy: "metadata" (default) |
rotation? | number | Rotation in degrees (default: 0). |
scale? | number | Scale multiplier (default: 1). |
size? | Size | Both dimensions in stage units or CSS length (default: unset). |
src? | string | Video source URL or media asset path (optional if passed as first argument). |
style? | Properties<0 | string & object, string & object> | - |
theme? | Partial<ThemeConfig> | - |
volume? | number | Volume level from 0.0 (silent) to 1.0 (maximum). Defaults to 1.0. |
width? | Size | Width in stage units or CSS length (default: content size). |
x? | PositionCoord | Horizontal position in stage units (default: 0). |
y? | PositionCoord | Vertical position in stage units (default: 0). |