API

Interface StreamingSound

A streaming, media-element-backed sound. Pure state — drive it with the streaming-sound functions.

interface StreamingSound {
    instanceCount: number;
    name?: string;
    onEnded: AudioSignal<StreamingSound>;
    preloadCompletedCount: number;
    state: SoundState;
}
Index
instanceCount: number

Number of live instances.

name?: string

Optional name.

Fires when the sound finishes (all instances ended).

preloadCompletedCount: number

Number of instances that have finished preloading.

state: SoundState

Current playback state.