Tone.Signal
↳ EXTENDS Tone.ParamA signal is an audio-rate value. Tone.Signal is a core component of the library. Unlike a number, Signals can be scheduled with sample-level accuracy. Tone.Signal has all of the methods available to native Web Audio AudioParam as well as additional conveniences. Read more about working with signals here.
CONSTRUCTOR
new Tone.Signal ( [Initial value of the signal. If an AudioParam is passed in, that parameter will be wrapped and controlled by the Signal.
unit The units the signal is in.
DEFAULTS
EXAMPLE
var signal = new Tone.Signal(10);Members
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.lfo
↝ Tone.LFO READONLY #The LFO created by the signal instance. If none was created, this is null.
Methods
.connect ( )
#The output number to connect from.
The input number to connect to.
this
When signals connect to other signals or AudioParams, they take over the output value of that signal or AudioParam. For all other nodes, the behavior is the same as a default connect.
.connect ( )
#optionally which output to connect from
optionally which input to connect to
this
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
.disconnect ( )
#Either the output index to disconnect if the output is an array, or the node to disconnect from.
this
disconnect the output
.toMaster ( )
#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();.cancelAndHoldAtTime ( )
#this
This is similar to cancelScheduledValues except it holds the automated value at cancelTime until the next automated event.
.linearRampToValueAtTime ( )
#Schedules a linear continuous change in parameter value from the previous scheduled parameter value to the given value.
.rampTo ( )
#The time that it takes the value to ramp from it’s current value
When the ramp should start.
this
Ramps to the given value over the duration of the rampTime. Automatically selects the best ramp type (exponential or linear) depending on the units of the signal
EXAMPLE
//ramp to the value either linearly or exponentially
//depending on the "units" value of the signal
signal.rampTo(0, 10);
EXAMPLE
//schedule it to ramp starting at a specific time
signal.rampTo(0, 10, 5).setRampPoint ( )
#(Optionally) pass the now value in.
this
Creates a schedule point with the current value at the current time. This is useful for creating an automation anchor point in order to schedule changes from the current value.
.setTargetAtTime ( )
#Start exponentially approaching the target value at the given time with a rate having the given time constant.
.setValueAtTime ( )
#The value to set the signal.
The time when the change should occur.
this
Schedules a parameter value change at the given time.
EXAMPLE
//set the frequency to "G4" in exactly 1 second from now.
freq.setValueAtTime("G4", "+1");.setValueCurveAtTime ( )
#Sets an array of arbitrary parameter values starting at the given time for the given duration.
.targetRampTo ( )
#The value to ramp to.
the time that it takes the value to ramp from it’s current value
When the ramp should start.
this
Start exponentially approaching the target value at the given time. Since it is an exponential approach it will continue approaching after the ramp duration. The rampTime is the time that it takes to reach over 99% of the way towards the value.
EXAMPLE
//exponentially ramp to the value 2 over 4 seconds.
signal.exponentialRampTo(2, 4);.linearRampTo ( )
#The value to ramp to.
the time that it takes the value to ramp from it’s current value
When the ramp should start.
this
Schedules an linear continuous change in parameter value from the current time and current value to the given value over the duration of the rampTime.
EXAMPLE
//linearly ramp to the value 4 over 3 seconds.
signal.linearRampTo(4, 3);.cancelScheduledValues ( )
#this
Cancels all scheduled parameter changes with times greater than or equal to startTime.
.exponentialRampTo ( )
#The value to ramp to.
the time that it takes the value to ramp from it’s current value
When the ramp should start.
this
Schedules an exponential continuous change in parameter value from the current time and current value to the given value over the duration of the rampTime.
EXAMPLE
//exponentially ramp to the value 2 over 4 seconds.
signal.exponentialRampTo(2, 4);.exponentialRampToValueAtTime ( )
#Schedules an exponential continuous change in parameter value from the previous scheduled parameter value to the given value.
.getTimeConstant ( )
#The time to convert
The time constant to get an exponentially approaching curve to over 99% of towards the target value.
Convert between Time and time constant. The time constant returned can be used in setTargetAtTime.