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

The latencyHint property can be number specifying a preferred maximum latency in seconds or a string from the AudioContextLatencyCategory enumerated string, which selects a standard value for a given type of audio usage:

Value Description
"balanced" The user agent should balance audio output latency and power consumption when selecting a latency value.
"interactive" The audio is involved in interactive elements, such as responding to user actions or needing to coincide with visual cues such as a video or game action. The user agent should select the lowest possible latency that doesn't cause glitches in the audio. This is likely to require increased power consumption. This is the default value.
"playback" The user agent should select a latency that will maximize playback time by minimizing power consumption at the expense of latency. Useful for non-interactive playback, such as playing music.

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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support60 ?61 No ? ?
latencyHint60 ?61 No ? ?
sampleRate No1 No61 No No ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support6060 ?61 ? ? ?
latencyHint6060 ?61 ? ? ?
sampleRate No ? No61 ? ? ?

1. See issue 432248 for Chrome support.

Document Tags and Contributors

Contributors to this page: Sheppy
Last updated by: Sheppy,