Tone.MidSideCompressor

↳ EXTENDS Tone.AudioNode

Tone.MidSideCompressor applies two different compressors to the mid and side signal components. See Tone.MidSideSplit.

CONSTRUCTOR

new Tone.MidSideCompressor (
options
)
options

The options that are passed to the mid and side compressors.

type: Object

DEFAULTS

{
mid :
{
ratio : 3 ,
threshold : -24 ,
release : 0.03 ,
attack : 0.02 ,
knee : 16
}
,
side :
{
ratio : 6 ,
threshold : -30 ,
release : 0.25 ,
attack : 0.03 ,
knee : 10
}
}

Members

.side

↝ Tone.Compressor #

The compressor applied to the side signal

</>

.mid

↝ Tone.Compressor #

The compressor applied to the mid signal

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

.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

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

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

</>

Methods

.dispose ( )

#
↪ returns Tone.MidSideCompressor

this

Clean up.

</>
↳ inherited from Tone.AudioNode

.chain ( )

#
nodes
type: AudioParam or Tone or AudioNode
↪ 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 ( )

#
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

.fan ( )

#
nodes
type: AudioParam or Tone or AudioNode
↪ 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