DynamicsCompressorNode

@native @JSType

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; it is created using the AudioContext.createDynamicsCompressor method.

  • Number of inputs: 1
  • Number of outputs: 1
  • Channel count mode: "explicit"
  • Channel count: 2
  • Channel interpretation: "speakers"
trait AudioNode
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Inherited methods

def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

Inherited from:
EventTarget
def connect(audioParam: AudioParam): Unit

Allows us to connect one output of this node to one input of an audio parameter.

Allows us to connect one output of this node to one input of an audio parameter.

Inherited from:
AudioNode
def connect(audioNode: AudioNode): Unit

Allows us to connect one output of this node to one input of another node.

Allows us to connect one output of this node to one input of another node.

Inherited from:
AudioNode
def disconnect(output: AudioNode): Unit

Allows us to disconnect the current node from another one it is already connected to.

Allows us to disconnect the current node from another one it is already connected to.

Value parameters:
output

The index describing which output of the AudioNode is going to be disconnected.

Inherited from:
AudioNode
def dispatchEvent(evt: Event): Boolean

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Inherited from:
EventTarget
def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

Inherited from:
EventTarget
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object

Concrete fields

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

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

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

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

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

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

Is a k-rate AudioParam representing the amount of gain reduction currently applied by the compressor to the signal.

Is a k-rate AudioParam representing the amount of gain reduction currently applied by the compressor to the signal.

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

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

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

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

Inherited fields

var channelCount: Int

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Inherited from:
AudioNode

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Inherited from:
AudioNode

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

The possible values are "speakers" or "discrete".

Inherited from:
AudioNode

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Inherited from:
AudioNode

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Inherited from:
AudioNode

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Inherited from:
AudioNode