AelionPlayerApi
Defined in: packages/sdk/src/types.ts:255
Properties
Section titled “Properties”currentTimeUs
Section titled “currentTimeUs”
readonlycurrentTimeUs:number
Defined in: packages/sdk/src/types.ts:257
readonlystate:AelionPlayerState
Defined in: packages/sdk/src/types.ts:256
Methods
Section titled “Methods”getStats()
Section titled “getStats()”getStats():
AelionPlayerStats
Defined in: packages/sdk/src/types.ts:263
Returns
Section titled “Returns”pause()
Section titled “pause()”pause():
Promise<void>
Defined in: packages/sdk/src/types.ts:259
Returns
Section titled “Returns”Promise<void>
play()
Section titled “play()”play():
Promise<void>
Defined in: packages/sdk/src/types.ts:258
Returns
Section titled “Returns”Promise<void>
reset()
Section titled “reset()”reset():
Promise<void>
Defined in: packages/sdk/src/types.ts:279
Releases the audio and video transport and returns the Player to idle.
Pausing keeps the runtime alive so playback can resume instantly. Resetting gives it back, which is what a host wants when the timeline is no longer being watched — switching Projects, closing the editor, or settling after a batch of edits.
Returns
Section titled “Returns”Promise<void>
scrub()
Section titled “scrub()”scrub(
timeUs):Promise<RenderIrFrameResult>
Defined in: packages/sdk/src/types.ts:261
Parameters
Section titled “Parameters”timeUs
Section titled “timeUs”number
Returns
Section titled “Returns”Promise<RenderIrFrameResult>
seek()
Section titled “seek()”seek(
timeUs):Promise<void>
Defined in: packages/sdk/src/types.ts:260
Parameters
Section titled “Parameters”timeUs
Section titled “timeUs”number
Returns
Section titled “Returns”Promise<void>
setPreviewQuality()
Section titled “setPreviewQuality()”setPreviewQuality(
options):void
Defined in: packages/sdk/src/types.ts:262
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Defined in: packages/sdk/src/types.ts:268
Takes ownership of presented frames. Exclusive: the listener must close
each result.bitmap, and exactly one consumer can be responsible for that.
Parameters
Section titled “Parameters”listener
Section titled “listener”(frame) => void
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
subscribeTime()
Section titled “subscribeTime()”subscribeTime(
listener): () =>void
Defined in: packages/sdk/src/types.ts:270
Follows the playhead without owning a frame. Any number of listeners.
Parameters
Section titled “Parameters”listener
Section titled “listener”(time) => void
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void