DynamicsCompressorNode

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 interface provides a compression effect, which lowers the volume of the loudest parts of the signal in order to help prevent clipping and distortion that can occur when multiple sounds are played and multiplexed together at once. This is often used in musical production and game audio. DynamicsCompressorNode is an AudioNode that has exactly one input and one output.

EventTarget AudioNode DynamicsCompressorNode
Number of inputs 1
Number of outputs 1
Channel count mode "clamped-max"
Channel count 2
Channel interpretation "speakers"

Constructor

DynamicsCompressorNode()

Creates a new instance of an DynamicsCompressorNode object.

Instance properties

Inherits properties from its parent, AudioNode.

DynamicsCompressorNode.threshold Read only

A k-rate AudioParam representing the decibel value above which the compression will start taking effect.

DynamicsCompressorNode.knee Read only

A k-rate AudioParam containing a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion.

DynamicsCompressorNode.ratio Read only

A k-rate AudioParam representing the amount of change, in dB, needed in the input for a 1 dB change in the output.

DynamicsCompressorNode.reduction Read only

A float representing the amount of gain reduction currently applied by the compressor to the signal.

DynamicsCompressorNode.attack Read only

A k-rate AudioParam representing the amount of time, in seconds, required to reduce the gain by 10 dB.

DynamicsCompressorNode.release Read only

A k-rate AudioParam representing the amount of time, in seconds, required to increase the gain by 10 dB.

Instance methods

No specific methods; inherits methods from its parent, AudioNode.

Example

See BaseAudioContext.createDynamicsCompressor() example code.

Specifications

Specification
Web Audio API
# DynamicsCompressorNode

Browser compatibility

BCD tables only load in the browser

See also