Skip to main content

Class: PlayerUI

Defined in: src/player/PlayerUI.ts:36

Constructors​

Constructor​

new PlayerUI(container, callbacks, options): PlayerUI

Defined in: src/player/PlayerUI.ts:71

Parameters​

container​

HTMLElement

callbacks​

PlayerUICallbacks

options​

PlayerUIOptions = {}

Returns​

PlayerUI

Methods​

dispose()​

dispose(): void

Defined in: src/player/PlayerUI.ts:669

Returns​

void

enableScrollScrub()​

enableScrollScrub(getTime): void

Defined in: src/player/PlayerUI.ts:628

Parameters​

getTime​

() => number

Returns​

void

setExportProgress()​

setExportProgress(progress): void

Defined in: src/player/PlayerUI.ts:524

Update the export button to show progress.

Parameters​

progress​

number

Returns​

void

setPlaying()​

setPlaying(playing, finished): void

Defined in: src/player/PlayerUI.ts:174

Parameters​

playing​

boolean

finished​

boolean = false

Returns​

void

setSegments()​

setSegments(timeline): void

Defined in: src/player/PlayerUI.ts:195

Parameters​

timeline​

MasterTimeline

Returns​

void

setSlidesMode()​

setSlidesMode(enabled): void

Defined in: src/player/PlayerUI.ts:188

Parameters​

enabled​

boolean

Returns​

void

showError()​

showError(message): void

Defined in: src/player/PlayerUI.ts:642

Show a temporary error message overlay on the player.

Parameters​

message​

string

Returns​

void

updateTime()​

updateTime(currentTime, duration): void

Defined in: src/player/PlayerUI.ts:165

Parameters​

currentTime​

number

duration​

number

Returns​

void