Interface StreamingSoundOptions

interface StreamingSoundOptions {
    autoplay?: boolean;
    loop?: boolean;
    maxInstances?: number;
    outBus?: PrimaryAudioBus;
    preloadCount?: number;
    startOffset?: number;
    volume?: number;
}

Properties

autoplay?: boolean

Play immediately once ready. Defaults to false.

loop?: boolean

Loop playback. Defaults to false.

maxInstances?: number

Maximum simultaneous instances. Defaults to Infinity.

Output bus. Defaults to the engine's default main bus.

preloadCount?: number

Number of instances to preload. Defaults to 1.

startOffset?: number

Start offset in seconds. Defaults to 0.

volume?: number

Initial volume. Defaults to 1.