Tone.Compressor

↳ EXTENDS Tone.AudioNode

Tone.Compressor is a thin wrapper around the Web Audio DynamicsCompressorNode. Compression reduces the volume of loud sounds or amplifies quiet sounds by narrowing or “compressing” an audio signal’s dynamic range. Read more on Wikipedia.

CONSTRUCTOR

new Tone.Compressor ( [
threshold
] , [
ratio
] )
threshold

The value above which the compression starts to be applied.

optional
ratio

The gain reduction ratio.

optional

DEFAULTS

{
ratio : 12 ,
threshold : -24 ,
release : 0.25 ,
attack : 0.003 ,
knee : 30
}

EXAMPLE

var comp = new Tone.Compressor(-30, 3);

Members

∿

.attack

↝ Time #

The attack parameter

</>
∿

.knee

↝ Decibels #

The knee parameter

</>
∿

.ratio

↝ Number #

The ratio value

</>
∿

.release

↝ Time #

The release parameter

</>
∿

.threshold

↝ Decibels #

the threshold vaue

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>

Methods

.dispose ( )

#
↪ returns Tone.Compressor

this

clean up

</>
↳ inherited from Tone.AudioNode

.connect ( )

#
unit
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.
↪ 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