Skip to content

Interface: VideoOptions ​

Defined in: types/desktop-engine.d.ts:776

Video constructor options

Extends ​

Properties ​

autoplay? ​

ts
optional autoplay?: boolean;

Defined in: types/desktop-engine.d.ts:786

Whether to play automatically; defaults to false


events? ​

ts
optional events?: string[];

Defined in: types/desktop-engine.d.ts:582

Event names to enable on the native side up front (JS still needs a callback to receive them)

Inherited from ​

ComponentOptions.events


initialTime? ​

ts
optional initialTime?: number;

Defined in: types/desktop-engine.d.ts:780

Initial playback position (seconds); defaults to 0


loop? ​

ts
optional loop?: boolean;

Defined in: types/desktop-engine.d.ts:788

Whether to loop; defaults to false


muted? ​

ts
optional muted?: boolean;

Defined in: types/desktop-engine.d.ts:790

Whether to mute; defaults to false


objectFit? ​

ts
optional objectFit?: VideoObjectFit;

Defined in: types/desktop-engine.d.ts:784

Scaling mode; defaults to contain


playbackRate? ​

ts
optional playbackRate?: number;

Defined in: types/desktop-engine.d.ts:782

Playback rate; defaults to 1.0


src? ​

ts
optional src?: string;

Defined in: types/desktop-engine.d.ts:778

Video source: an http(s) URL or a path inside the package or sandbox


style? ​

ts
optional style?: StyleProperties;

Defined in: types/desktop-engine.d.ts:580

Initial style

Inherited from ​

ComponentOptions.style


volume? ​

ts
optional volume?: number;

Defined in: types/desktop-engine.d.ts:792

Volume from 0 to 1; defaults to 1.0

The SDK is released under the Apache License 2.0