GitHub
API reference
Preparing search index…

SoundStreamCallbacks

Playback stream callbacks executed in a Node Worker.

interface SoundStreamCallbacks {
    onClose(): void | Promise<void>;
    onGetData(chunk: SoundStreamChunk): boolean | Promise<boolean>;
    onLoop(): undefined | bigint | Promise<undefined | bigint>;
    onSeek(offset: Time): void | Promise<void>;
}
Source & inheritance
Member directory4

Methods

Methods

  • Release data source resources when the Worker session closes.

    Returns

    void | Promise<void>
    Source & inheritance

  • Called while preparing the final block; returns an interleaved sample offset. undefined disables this loop, 0n restarts from the beginning.

    Returns

    undefined | bigint | Promise<undefined | bigint>
    Source & inheritance

  • Seek the data source to the specified playback time.

    Parameters

    offset
    Time

    Returns

    void | Promise<void>
    Source & inheritance

Settings

Member Visibility

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0