AudioContextOptions.sampleRate

The AudioContextOptions dictionary (used when instantiating an AudioContext) may contain a property named sampleRate, which indicates the sample rate to use for the new context. The value must be a floating-point value indicating the sample rate, in samples per second, for which to configure the new context; additionally, the value must be one which is supported by AudioBuffer.sampleRate.

Syntax

audioContextOptions.sampleRate = 44100;

var sampleRate = audioContextOptions.sampleRate;

Value

The desired sample rate for the AudioContext, specified in samples per second. The value must be compatible with AudioBuffer.sampleRate. This value should typically be between 8,000 Hz and 96,000 Hz; the default will vary depending on the output device, but the sample rate 44,100 Hz is the most common.

If the sampleRate property is not included in the options, or the options are not specified when creating the audio context, the new context's output device's preferred sample rate is used by default.

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also