Class: Player
Defined in: player/Player.ts:129
Constructors
Constructor
new Player(
container,options):Player
Defined in: player/Player.ts:145
Parameters
container
HTMLElement
options
PlayerOptions = {}
Returns
Player
Accessors
isPlaying
Get Signature
get isPlaying():
boolean
Defined in: player/Player.ts:248
Whether playback is active.
Returns
boolean
scene
Get Signature
get scene():
Scene
Defined in: player/Player.ts:238
Get the underlying scene for direct manipulation.
Returns
timeline
Get Signature
get timeline():
MasterTimeline
Defined in: player/Player.ts:243
Get the master timeline.
Returns
Methods
dispose()
dispose():
void
Defined in: player/Player.ts:357
Clean up all resources.
Returns
void
exportAs()
exportAs(
format):Promise<void>
Defined in: player/Player.ts:319
Export the animation in the given format (gif, webm, mp4).
Parameters
format
string
Returns
Promise<void>
nextSegment()
nextSegment():
void
Defined in: player/Player.ts:288
Jump to the next segment. Pauses playback (YouTube-style).
Returns
void
pause()
pause():
void
Defined in: player/Player.ts:264
Pause playback.
Returns
void
play()
play():
void
Defined in: player/Player.ts:253
Start playback from current position.
Returns
void
prevSegment()
prevSegment():
void
Defined in: player/Player.ts:301
Jump to the previous segment. Pauses playback (YouTube-style).
Returns
void
seek()
seek(
time):void
Defined in: player/Player.ts:281
Seek to a specific time in seconds.
Parameters
time
number
Returns
void
sequence()
sequence(
builder):Promise<void>
Defined in: player/Player.ts:213
Define the animation sequence. The callback receives a recording proxy that captures all play()/wait() calls to build the master timeline.
Parameters
builder
(scene) => Promise<void>
Returns
Promise<void>
setPlaybackRate()
setPlaybackRate(
rate):void
Defined in: player/Player.ts:314
Set the playback speed multiplier.
Parameters
rate
number
Returns
void
toggleFullscreen()
toggleFullscreen():
void
Defined in: player/Player.ts:346
Toggle browser fullscreen on the player container.
Returns
void
togglePlayPause()
togglePlayPause():
void
Defined in: player/Player.ts:272
Toggle between play and pause.
Returns
void