Skip to main content

Class: PlayerUI

Defined in: player/PlayerUI.ts:24

Constructors

Constructor

new PlayerUI(container, callbacks, options): PlayerUI

Defined in: player/PlayerUI.ts:55

Parameters

container

HTMLElement

callbacks

PlayerUICallbacks

options

PlayerUIOptions = {}

Returns

PlayerUI

Methods

dispose()

dispose(): void

Defined in: player/PlayerUI.ts:601

Returns

void


enableScrollScrub()

enableScrollScrub(getTime): void

Defined in: player/PlayerUI.ts:560

Parameters

getTime

() => number

Returns

void


setExportProgress()

setExportProgress(progress): void

Defined in: player/PlayerUI.ts:479

Update the export button to show progress.

Parameters

progress

number

Returns

void


setPlaying()

setPlaying(playing, finished): void

Defined in: player/PlayerUI.ts:155

Parameters

playing

boolean

finished

boolean = false

Returns

void


setSegments()

setSegments(timeline): void

Defined in: player/PlayerUI.ts:169

Parameters

timeline

MasterTimeline

Returns

void


showError()

showError(message): void

Defined in: player/PlayerUI.ts:574

Show a temporary error message overlay on the player.

Parameters

message

string

Returns

void


updateTime()

updateTime(currentTime, duration): void

Defined in: player/PlayerUI.ts:146

Parameters

currentTime

number

duration

number

Returns

void