API
Babylon Lite API|
StaticSoundOptions

Interface StaticSoundOptions

Options for createSoundAsync.

interface StaticSoundOptions {
    autoplay?: boolean;
    duration?: number;
    loop?: boolean;
    loopEnd?: number;
    loopStart?: number;
    maxInstances?: number;
    outBus?: PrimaryAudioBus;
    pitch?: number;
    playbackRate?: number;
    skipCodecCheck?: boolean;
    startOffset?: number;
    volume?: number;
}

Hierarchy (View Summary)

Index
autoplay? duration? loop? loopEnd? loopStart? maxInstances? outBus? pitch? playbackRate? skipCodecCheck? startOffset? volume?
autoplay?: boolean

Play immediately once ready. Defaults to false.

duration?: number

Play duration in seconds (0 = full buffer). Defaults to 0.

loop?: boolean

Loop playback. Defaults to false.

loopEnd?: number

Loop end point in seconds. Defaults to 0.

loopStart?: number

Loop start point in seconds. Defaults to 0.

maxInstances?: number

Maximum simultaneous instances. Defaults to Infinity.

outBus?: PrimaryAudioBus

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

pitch?: number

Detune in cents. Defaults to 0.

playbackRate?: number

Playback rate multiplier. Defaults to 1.

skipCodecCheck?: boolean

Skip the browser codec check when selecting among multiple URLs.

startOffset?: number

Start offset in seconds. Defaults to 0.

volume?: number

Initial volume. Defaults to 1.