ConvolverNode()

The ConvolverNode() constructor of the Web Audio API creates a new ConvolverNode object instance.

Syntax

var convolverNode = new ConvolverNode(context, options)

Parameters

Inherits parameters from the AudioNodeOptions dictionary.

context
A reference to an AudioContext.
options Optional
Options are as follows:
  • audioBuffer: A mono, stereo, or 4-channel AudioBuffer containing the (possibly multichannel) impulse response used by the ConvolverNode to create the reverb effect.
  • disableNormalization: A Boolean controlling whether the impulse response from the buffer will be scaled by an equal-power normalization, or not. The default is 'false'.

Return value

A new ConvolverNode object instance.

Exceptions

Exception Explanation
NotSupportedError The referenced AudioBuffer does not have the correct number of channels, or it has a different sample rate to the associated AudioContext.

Specifications

Specification Status Comment
Unknown
The definition of 'ConvolverNode()' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser