Tone.Param
↳ EXTENDS Tone.AudioNodeTone.Param wraps the native Web Audio’s AudioParam to provide additional unit conversion functionality. It also serves as a base-class for classes which have a single, automatable parameter.
CONSTRUCTOR
new Tone.Param (The parameter to wrap.
The units of the audio param.
If the param should be converted.
DEFAULTS
- convert
- units
- value
- value
- value
- numberOfOutputs
- numberOfInputs
- channelCountMode
- channelInterpretation
- context
- channelCount
- _exponentialApproach
- _exponentialInterpolate
- _linearInterpolate
- cancelAndHoldAtTime
- cancelScheduledValues
- setRampPoint
- setTargetAtTime
- setValueAtTime
- setValueCurveAtTime
- targetRampTo
- dispose
- exponentialApproachValueAtTime
- exponentialRampTo
- exponentialRampToValueAtTime
- getValueAtTime
- linearRampTo
- linearRampToValueAtTime
- rampTo
- chain
- connect
- disconnect
- fan
- toMaster
Members
.numberOfOutputs
↝ Number READONLY #The number of outputs coming out of the AudioNode.
.numberOfInputs
↝ Number READONLY #The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
.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.
.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”.
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.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.
Methods
.cancelAndHoldAtTime ( )
#this
This is similar to cancelScheduledValues except it holds the automated value at time until the next automated event.
.cancelScheduledValues ( )
#this
Cancels all scheduled parameter changes with times greater than or equal to startTime.
.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 ( )
#If the values in the curve should be scaled by some value
this
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);.exponentialApproachValueAtTime ( )
#The value to ramp to.
When the ramp should start.
the time that it takes the value to ramp from it’s current value
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. This methods is similar to setTargetAtTime except the third argument is a time instead of a ‘timeConstant’
EXAMPLE
//exponentially ramp to the value 2 over 4 seconds.
signal.exponentialRampTo(2, 4);.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.
.getValueAtTime ( )
#Get the signals value at the given time. Subsequent scheduling may invalidate the returned value.
.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);.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).chain ( )
#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);
.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
.fan ( )
#this
connect the output of this node to the rest of the nodes in parallel.
.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();