Class SmartPlayer

Index

Constructors

Accessors

playing renderTime

Methods

dequeueScore dequeueScores enqueueMutation enqueueScore getJson getPlaybackDescription seek setJson

Constructors

constructor

new SmartPlayer(renderer?: BaseRenderer): SmartPlayer
Parameters
- renderer: BaseRenderer = ...
Returns SmartPlayer
- Defined in SmartPlayer.ts:33

Accessors

playing

get playing(): boolean
Returns boolean
- Defined in SmartPlayer.ts:55
set playing(state: boolean): void
Parameters
- state: boolean
Returns void
- Defined in SmartPlayer.ts:59

renderTime

get renderTime(): TimeInstant
Returns TimeInstant
- Defined in SmartPlayer.ts:63
set renderTime(time: TimeInstant): void
Parameters
- time: TimeInstant
Returns void
Deprecated
- Defined in SmartPlayer.ts:68

Methods

dequeueScore

dequeueScore(graphId: string, fadeOut?: boolean): Promise<void>
Parameters
- graphId: string
- fadeOut: boolean = true
Returns Promise<void>
- Defined in SmartPlayer.ts:115

dequeueScores

dequeueScores(): Promise<void[]>
Returns Promise<void[]>
- Defined in SmartPlayer.ts:119

enqueueMutation

enqueueMutation(effect: Mutation): Promise<void>
Parameters
- effect: Mutation
Returns Promise<void>
- Defined in SmartPlayer.ts:88

enqueueScore

enqueueScore(score: string, fadeIn?: boolean): Promise<void>
Parameters
- score: string
- OptionalfadeIn: boolean
Returns Promise<void>
- Defined in SmartPlayer.ts:92
enqueueScore(score: Score, fadeIn?: boolean): Promise<void>
Parameters
- score: Score
- OptionalfadeIn: boolean
Returns Promise<void>
- Defined in SmartPlayer.ts:93

getJson

getJson(graphId?: string): string
Parameters
- OptionalgraphId: string
Returns string
- Defined in SmartPlayer.ts:47

getPlaybackDescription

getPlaybackDescription(renderTime: TimeInstant): NodePlaybackDescription[]
Parameters
- renderTime: TimeInstant
Returns NodePlaybackDescription[]
- Defined in SmartPlayer.ts:82

seek

seek(time: TimeInstant): Promise<void>
Set renderTime to time. Seeking / setting renderTime is actually an asynchronous process since the internal graph must be destroyed and rebuilt, and potentially new content loaded. seek allows a user to await the operation, unlike set/get renderTime.
Parameters
- time: TimeInstant
Returns Promise<void>
- Defined in SmartPlayer.ts:78

setJson

setJson(json: string): Promise<void>
Parameters
- json: string
Returns Promise<void>
- Defined in SmartPlayer.ts:35