DynamicsCompressorNode class abstract
The DynamicsCompressorNode
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.
Number of inputs | 1 |
---|---|
Number of outputs | 1 |
Channel count mode | "clamped-max" |
Channel count | 2 |
Channel interpretation | "speakers" |
API documentation sourced from MDN Web Docs.
- Implemented types
Constructors
Properties
- attack → AudioParam
-
The
attack
property of the DynamicsCompressorNode is a k-rate AudioParam representing the amount of time, in seconds, required to reduce the gain by 10 dB. It defines how quickly the signal is adapted when its volume is increased.no setter - channelCount ↔ int
-
The
channelCount
property of the AudioNode represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.getter/setter pairinherited - channelCountMode ↔ ChannelCountMode
-
The
channelCountMode
property of the AudioNode represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.getter/setter pairinherited - channelInterpretation ↔ ChannelInterpretation
-
The
channelInterpretation
property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different. For example, this setting defines how a mono input will be up-mixed to a stereo or 5.1 channel output, or how a quad channel input will be down-mixed to a stereo or mono output.getter/setter pairinherited - context → BaseAudioContext
-
The read-only
context
property of the AudioNode returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- knee → AudioParam
-
The
knee
property of the DynamicsCompressorNode is a k-rate AudioParam containing a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion.no setter - numberOfInputs → int
-
The
numberOfInputs
property of the AudioNode returns the number of inputs feeding the node. Source nodes are defined as nodes having anumberOfInputs
property with a value of 0.no setterinherited - numberOfOutputs → int
-
The
numberOfOutputs
property of the AudioNode returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.no setterinherited - ratio → AudioParam
-
The
ratio
property of the DynamicsCompressorNode Is a k-rate AudioParam representing the amount of change, in dB, needed in the input for a 1 dB change in the output.no setter - reduction → double
-
The
reduction
read-only property of the DynamicsCompressorNode is a float representing the amount of gain reduction currently applied by the compressor to the signal.no setter - release → AudioParam
-
The
release
property of the DynamicsCompressorNode Is a k-rate AudioParam representing the amount of time, in seconds, required to increase the gain by 10 dB. It defines how quick the signal is adapted when its volume is reduced.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- threshold → AudioParam
-
The
threshold
property of the DynamicsCompressorNode is a k-rate AudioParam representing the decibel value above which the compression will start taking effect.no setter
Methods
-
connect(
AudioNode destinationNode, [int output, int input]) → AudioNode -
The
connect()
method of the AudioNode lets you connect one of the node's outputs to a target, which may be either anotherAudioNode
(thereby directing the sound data to the specified node). See also AudioNode.connectParaminherited -
connectParam(
AudioParam destinationParam, [int output, int input]) → void -
This is a variant of AudioNode.connect with a
DestinationParam
argument instead of anAudioNode
. Note : The W3C recommandation uses just one verb for both.inherited -
disconnect(
[AudioNode destinationParamOrOutput, int output, int input]) → void -
The
disconnect()
method of the AudioNode lets you disconnect one or more nodes from the node on which the method is called. See also AudioNode.disconnectParaminherited -
disconnectParam(
AudioParam destinationParam, [int output, int input]) → void -
This is a variant of AudioNode.disconnect with a
DestinationParam
argument instead of anAudioNode
. Note : The W3C recommandation uses just one verb for both.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited