Tone.Limiter

↳ EXTENDS Tone.AudioNode

Tone.Limiter will limit the loudness of an incoming signal. It is composed of a Tone.Compressor with a fast attack and release. Limiters are commonly used to safeguard against signal clipping. Unlike a compressor, limiters do not provide smooth gain reduction and almost completely prevent additional gain above the threshold.

CONSTRUCTOR

new Tone.Limiter (
threshold
)
threshold

The theshold above which the limiting is applied.

type: number

DEFAULTS

{
threshold : -12
}

EXAMPLE

var limiter = new Tone.Limiter(-6);

Members

.threshold

Decibel #

The threshold of of the limiter

</>
inherited from Tone.AudioNode

.channelCount

Number READONLY #

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

</>
inherited from Tone.AudioNode

.channelCountMode

String READONLY #

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is “max”. This attribute has no effect for nodes with no inputs.

</>
inherited from Tone.AudioNode

.channelInterpretation

String READONLY #

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is “speakers”.

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
inherited from Tone.AudioNode

.numberOfInputs

Number READONLY #

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

</>
inherited from Tone.AudioNode

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

</>

Methods

.dispose ( )

#
↪ returns Tone.Limiter

this

Clean up.

</>
inherited from Tone.AudioNode

.connect ( )

#
unit
type: Tone or AudioParam or AudioNode
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

</>
inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.

type: Number or AudioNode
↪ returns Tone.AudioNode

this

disconnect the output

</>
inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

this

Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)

EXAMPLE

//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();
</>
docs generated Sep 15 2019