DynamicsCompressorNode: DynamicsCompressorNode() constructor
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.
The DynamicsCompressorNode() constructor creates a new DynamicsCompressorNode object instance, which can be used to provide a compression effect that lowers the volume of the loudest parts of a signal.
Compression can help prevent clipping and distortion when multiple sounds are combined, and it is also used in music production and game audio for dynamic control, tone shaping, and creative effects.
Syntax
new DynamicsCompressorNode(context, options)
Parameters
context-
A reference to an
AudioContext. optionsOptional-
Options are as follows:
attack-
The amount of time (in seconds) to reduce the gain by 10dB. Its default value is 0.003. This parameter is k-rate. Its nominal range is [0, 1].
knee-
A decibel value representing the range above the threshold where the curve smoothly transitions to the "ratio" portion. Its default value is 30. This parameter is k-rate. Its nominal range is [0, 40].
ratio-
The amount of dB change in input for a 1 dB change in output. Its default value is 12. This parameter is k-rate. Its nominal range is [1, 20].
release-
The amount of time (in seconds) to increase the gain by 10dB. Its default value is 0.250. This parameter is k-rate. Its nominal range is [0, 1].
threshold-
The decibel value above which the compression will start taking effect. Its default value is -24. This parameter is k-rate. Its nominal range is[-100, 0].
Specifications
| Specification |
|---|
| Web Audio API # dom-dynamicscompressornode-dynamicscompressornode |
Browser compatibility
Enable JavaScript to view this browser compatibility table.