API

Interface AudioEngineOptions

interface AudioEngineOptions {
    audioContext?: BaseAudioContext;
    parameterRampDuration?: number;
    resumeOnInteraction?: boolean;
    resumeOnPause?: boolean;
    resumeOnPauseRetryInterval?: number;
    volume?: number;
}
Index
audioContext?: BaseAudioContext

The audio context to use. Pass an OfflineAudioContext for deterministic, faster-than-realtime rendering (used by the audio test suite). When omitted a real-time AudioContext is created.

parameterRampDuration?: number

Default parameter ramp smoothing, in seconds. Defaults to 0.01.

resumeOnInteraction?: boolean

Auto-resume the context on user interaction (click). Defaults to true.

resumeOnPause?: boolean

Auto-resume the context if the browser pauses playback. Defaults to true.

resumeOnPauseRetryInterval?: number

Retry interval (ms) for resumeOnPause. Defaults to 1000.

volume?: number

Master output volume. Defaults to 1.