Tone.Source

↳ EXTENDS Tone.AudioNode

Base class for sources. Sources have start/stop methods and the ability to be synced to the start/stop of Tone.Transport.

CONSTRUCTOR

new Tone.Source ( )

DEFAULTS

{
volume : 0 ,
mute : false
}

EXAMPLE

//Multiple state change events can be chained together,
//but must be set in the correct order and with ascending times

// OK
state.start().stop("+0.2");
// AND
state.start().stop("+0.2").start("+0.4").stop("+0.7")

// BAD
state.stop("+0.2").start();
// OR
state.start("+0.3").stop("+0.2");

Members

∿

.volume

↝ Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;
</>

.fadeIn

↝ Time #

The fadeIn time of the amplitude envelope.

</>

.fadeOut

↝ Time #

The fadeOut time of the amplitude envelope.

</>

.mute

↝ boolean #

Mute the output.

EXAMPLE

//mute the output
source.mute = true;
</>

.mute

↝ boolean #

Mute the output.

EXAMPLE

//mute the output
source.mute = true;
</>

.state

↝ Tone.State READONLY #

Returns the playback state of the source, either “started” or “stopped”.

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

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

</>

Methods

.unsync ( )

#
↪ returns Tone.Source

this

Unsync the source to the Transport. See Tone.Source.sync

</>

.start ( )

#
time

When the source should be started.

type: Time
default: now
↪ returns Tone.Source

this

Start the source at the specified time. If no time is given, start the source now.

EXAMPLE

source.start("+0.5"); //starts the source 0.5 seconds from now
</>

.stop ( )

#
time

When the source should be stopped.

type: Time
default: now
↪ returns Tone.Source

this

Stop the source at the specified time. If no time is given, stop the source now.

EXAMPLE

source.stop(); // stops the source immediately
</>

.sync ( )

#
↪ returns Tone.Source

this

Sync the source to the Transport so that all subsequent calls to start and stop are synced to the TransportTime instead of the AudioContext time.

EXAMPLE

//sync the source so that it plays between 0 and 0.3 on the Transport's timeline
source.sync().start(0).stop(0.3);
//start the transport.
Tone.Transport.start();

EXAMPLE

//start the transport with an offset and the sync'ed sources
//will start in the correct position
source.sync().start(0.1);
//the source will be invoked with an offset of 0.4
Tone.Transport.start("+0.5", 0.5);
</>

.dispose ( )

#
↪ returns Tone.Source

this

Clean up.

</>
↳ 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();
</>
↳ 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

</>
docs generated Sep 15 2019