Class: Player

The player logic used by the editor and embeddable player.

Remarks

This class builds on top of the PlaybackManager to provide a simple interface similar to other media players. It plays through the animation using a real-time update loop.

Constructors

Constructor

new Player(project, settings?, initialState?, initialFrame?): Player

Defined in: app/Player.ts:119

Parameters

project

Project

settings?

Partial<PlayerSettings> = {}

initialState?

Partial<PlayerState> = {}

initialFrame?

number = -1

Returns

Player

Properties

logger

readonly logger: Logger

Defined in: app/Player.ts:86

playback

readonly playback: PlaybackManager

Defined in: app/Player.ts:84

status

readonly status: PlaybackStatus

Defined in: app/Player.ts:85

Accessors

onDurationChanged

Get Signature

get onDurationChanged(): SubscribableValueEvent<number>

Defined in: app/Player.ts:66

Returns

SubscribableValueEvent<number>

onFrameChanged

Get Signature

get onFrameChanged(): SubscribableValueEvent<number>

Defined in: app/Player.ts:61

Returns

SubscribableValueEvent<number>

onStateChanged

Get Signature

get onStateChanged(): SubscribableValueEvent<PlayerState>

Defined in: app/Player.ts:56

Returns

SubscribableValueEvent<PlayerState>

Methods

activate()

activate(): void

Defined in: app/Player.ts:314

Activate the player.

Returns

void

Remarks

A player needs to be active in order for the update loop to run. Each player is active by default.

addAudioVolume()

addAudioVolume(value): void

Defined in: app/Player.ts:285

Parameters

value

number

Returns

void

clampRange()

clampRange(frame): number

Defined in: app/Player.ts:465

Parameters

frame

number

Returns

number

configure()

configure(settings): Promise<void>

Defined in: app/Player.ts:164

Parameters

settings

PlayerSettings

Returns

Promise<void>

deactivate()

deactivate(): void

Defined in: app/Player.ts:329

Deactivate the player.

Returns

void

Remarks

Deactivating the player prevents its update loop from running. This should be done before disposing the player, to prevent it from running in the background.

Just pausing the player does not stop the loop.

isInRange()

isInRange(frame): boolean

Defined in: app/Player.ts:203

Whether the given frame is inside the animation range.

Parameters

frame

number

The frame to check.

Returns

boolean

isInUserRange()

isInUserRange(frame): boolean

Defined in: app/Player.ts:212

Whether the given frame is inside the user-defined range.

Parameters

requestSeek()

requestSeek(value): void

Defined in: app/Player.ts:216

Parameters

value

number

Returns

void

setAudioVolume()

setAudioVolume(value): void

Defined in: app/Player.ts:275

Parameters

value

number

Returns

void

setSpeed()

setSpeed(value): void

Defined in: app/Player.ts:289

Parameters

value

number

Returns

void

setVariables()

setVariables(variables): void

Defined in: app/Player.ts:301

Parameters

variables

Record<string, unknown>

Returns

void

toggleAudio()

toggleAudio(value?): void

Defined in: app/Player.ts:266

Parameters

value?

boolean = ...

Returns

void

toggleLoop()

toggleLoop(value?): void

Defined in: app/Player.ts:236

Parameters

value?

boolean = ...

Returns

void

togglePlayback()

togglePlayback(value?): void

Defined in: app/Player.ts:245

Parameters

value?

boolean = ...

Returns

void

Events

onRecalculated

Get Signature

get onRecalculated(): Subscribable<void, EventHandler<void>>

Defined in: app/Player.ts:79

Triggered right after recalculation finishes.

Remarks

Can be used to provide visual feedback.

Returns

Subscribable<void, EventHandler<void>>

onRender

Get Signature

get onRender(): Subscribable<void, AsyncEventHandler<void>>

Defined in: app/Player.ts:51

Triggered during each iteration of the update loop when the frame is ready to be rendered.

Remarks

Player does not perform any rendering on its own. For the animation to be visible, another class must subscribe to this event and perform the rendering itself. Stage can be used to display the animation.

Returns

Subscribable<void, AsyncEventHandler<void>>