Class Video

Hierarchy

Video

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Video(): Video

Returns Video

Properties

currentPosition

currentPosition: number

Defines the track position of this video.

returns: current track position in this video in seconds.

Readonly duration

duration: number

returns: duration of the video in seconds.

looping

looping: boolean

Toggles video looping. If true, video playback starts from start when end is reached.

returns: video looping state.

Readonly playing

playing: boolean

returns: true if video is playing.

volume

volume: number

Defines normalized volume of this video. Value is clamped to range [0,1]

returns: volume of video.

Methods

onLoaded

onLoaded(handler: (() => void)): Disposable

- Defined in api.ts:1953
Handles the loading event for this video.

Parameters
- handler: (() => void)
  
  function to call when video has loaded (and can be played).
  - - (): void
    - Returns void
Returns Disposable

pause

pause(): void

- Defined in api.ts:1908
Pauses video playback.

Video resumes at the same track position with next play call.

Returns void

play

play(): void

- Defined in api.ts:1901
Starts video playback.

Note: Video content is streamed.

Returns void

stop

stop(): void

- Defined in api.ts:1915
Stops video.

Video starts from the beginning with new play call.

Returns void