VideoOptions
Defined in: domains/ui.ts:6
Properties
Section titled “Properties”autoplay?
Section titled “autoplay?”optional autoplay?: boolean;Defined in: domains/ui.ts:8
Start playback automatically. Defaults to true in the browser fallback.
optional loop?: boolean;Defined in: domains/ui.ts:10
Loop the video continuously.
muted?
Section titled “muted?”optional muted?: boolean;Defined in: domains/ui.ts:12
Start the video muted.
startTime?
Section titled “startTime?”optional startTime?: number;Defined in: domains/ui.ts:14
Start playback from this position in seconds.
endTime?
Section titled “endTime?”optional endTime?: number;Defined in: domains/ui.ts:16
Stop playback at this position in seconds.
optional rate?: number;Defined in: domains/ui.ts:18
Playback speed multiplier (e.g. 1.5 for 1.5× speed).
showControls?
Section titled “showControls?”optional showControls?: boolean;Defined in: domains/ui.ts:20
Show the native playback controls.
allowScrubbing?
Section titled “allowScrubbing?”optional allowScrubbing?: boolean;Defined in: domains/ui.ts:22
Allow the user to scrub (seek) through the video.
allowedSpeeds?
Section titled “allowedSpeeds?”optional allowedSpeeds?: number[];Defined in: domains/ui.ts:24
Allowed playback speeds to offer the user.
allowPiP?
Section titled “allowPiP?”optional allowPiP?: boolean;Defined in: domains/ui.ts:26
Allow Picture-in-Picture mode.
allowAirPlay?
Section titled “allowAirPlay?”optional allowAirPlay?: boolean;Defined in: domains/ui.ts:28
Allow AirPlay output.
allowFullscreen?
Section titled “allowFullscreen?”optional allowFullscreen?: boolean;Defined in: domains/ui.ts:30
Allow full-screen mode.
title?
Section titled “title?”optional title?: string;Defined in: domains/ui.ts:32
Title to display in the player UI.
videoGravity?
Section titled “videoGravity?”optional videoGravity?: "fill" | "fit" | "stretch";Defined in: domains/ui.ts:34
How to fit the video within its display area.