Tone.MultibandCompressor

↳ EXTENDS Tone.AudioNode

A compressor with seperate controls over low/mid/high dynamics

CONSTRUCTOR

new Tone.MultibandCompressor (
options
)
options

The low/mid/high compressor settings.

type: Object

DEFAULTS

{
low : Tone.Compressor.defaults ,
mid : Tone.Compressor.defaults ,
high : Tone.Compressor.defaults ,
lowFrequency : 250 ,
highFrequency : 2000
}

EXAMPLE

var multiband = new Tone.MultibandCompressor({
 	"lowFrequency" : 200,
 	"highFrequency" : 1300
 	"low" : {
 		"threshold" : -12
 	}
 })

Members

.low

Tone.Compressor #

The compressor applied to the low frequencies.

</>

.lowFrequency

Frequency #

low/mid crossover frequency.

</>

.mid

Tone.Compressor #

The compressor applied to the mid frequencies.

</>

.high

Tone.Compressor #

The compressor applied to the high frequencies.

</>

.highFrequency

Frequency #

mid/high crossover frequency.

</>
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

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

</>
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.

</>

Methods

.dispose ( )

#
↪ returns Tone.MultibandCompressor

this

clean up

</>
inherited from Tone.AudioNode

.chain ( )

#
nodes
↪ returns Tone.AudioNode

this

Connect the output of this node to the rest of the nodes in series.

EXAMPLE

//connect a node to an effect, panVol and then to the master output
 node.chain(effect, panVol, Tone.Master);
 
</>
inherited from Tone.AudioNode

.connect ( )

#
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

.fan ( )

#
nodes
↪ returns Tone.AudioNode

this

connect the output of this node to the rest of the nodes in parallel.

</>
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