AudioContextOptions

The AudioContextOptions dictionary is used to specify configuration options when constructing a new AudioContext object to represent a graph of web audio nodes. It is only used when calling the AudioContext() constructor.

Properties

latencyHint Optional
The type of playback that the context will be used for, as a value from the AudioContextLatencyCategory enum or a double-precision floating-point value indicating the preferred maximum latency of the context in seconds. The user agent may or may not choose to meet this request; check the value of AudioContext.baseLatency to determine the true latency after creating the context.
sampleRate Optional
The sampleRate to be used by the AudioContext, specified in samples per second. The value may be any value supported by AudioBuffer. If not specified, the preferred sample rate for the context's output device is used by default.

Constants

Standard values for latencyHint

Standard values for the latencyHint property are provided in the AudioContextLatencyCategory enumerated string. These select an appropriate value for a given type of audio usage, e.g. "balanced", "interactive" or "playback". You can also specify a preferred maximum latency in seconds.

Example

This example instantiates an audio context for music playback (optimized for power consumption over latency), with the sample rate 48,000 Hz.

let musicContext = new AudioContext({
  latencyHint: "playback",
  sampleRate: 48000
});

Specifications

Specification Status Comment
Web Audio API
The definition of 'AudioContextOptions' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser