Tone.Solo

↳ EXTENDS Tone.AudioNode

Tone.Solo lets you isolate a specific audio stream. When an instance is set to solo=true, it will mute all other instances.

CONSTRUCTOR

new Tone.Solo ( )

DEFAULTS

{
solo : false
}

EXAMPLE

var soloA = new Tone.Solo()
var soloB = new Tone.Solo()
soloA.solo = true
//no audio will pass through soloB

Members

.solo

Boolean #

Isolates this instance and mutes all other instances of Tone.Solo. Only one instance can be soloed at a time. A soloed instance will report solo=false when another instance is soloed.

</>

.input

Tone.Gain #

The input and output node

</>

.muted

Boolean READONLY #

If the current instance is muted, i.e. another instance is soloed

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
inherited from Tone.AudioNode

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

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

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

</>

Methods

.dispose ( )

#
↪ returns Tone.Solo

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