Protected_The timeline which tracks all of the automations.
Protected_The default value before anything is assigned
Protected_The native parameter to control
Protected Readonly_If the underlying AudioParam can be swapped out using the setParam method.
ReadonlycontextThe context belonging to the node.
If the value should be converted or not
Set this debug flag to log all events that happen in this class.
ReadonlyinputReadonlynameThe name of the class
True if the signal value is being overridden by a connected signal. Internal use only.
ReadonlyunitsThe unit type
StaticversionThe version number semver
Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.
The maximum value of the output given the units
The minimum value of the output given the units
A multiplier on the bpm value. Useful for setting a PPQ relative to the base frequency value.
The duration in seconds of one sample.
Protected_Protected_Protected_Protected_Get a subset of the properties which are in the partial props
Protected_Protected_Apply all of the previously scheduled events to the passed in Param or AudioParam. The applied values will start at the context's current time and schedule all of the events which are scheduled on this Param onto the passed in param.
This is similar to cancelScheduledValues except it holds the automated value at time until the next automated event.
Cancels all scheduled parameter changes with times greater than or equal to startTime.
return Tone.Offline(() => {
const signal = new Tone.Signal(0).toDestination();
signal.setValueAtTime(0.1, 0.1);
signal.setValueAtTime(0.2, 0.2);
signal.setValueAtTime(0.3, 0.3);
signal.setValueAtTime(0.4, 0.4);
// cancels the last two scheduled changes
signal.cancelScheduledValues(0.3);
}, 0.5, 1);
disconnect and dispose.
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'
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.
const delay = new Tone.FeedbackDelay(0.5, 0.98).toDestination();
// a short burst of noise through the feedback delay
const noise = new Tone.Noise().connect(delay).start().stop("+0.1");
// making the delay time shorter over time will also make the pitch rise
delay.delayTime.exponentialRampTo(0.01, 20);
Schedules an exponential continuous change in parameter value from the previous scheduled parameter value to the given value.
Get the object's attributes.
Return the elapsed time of the number of ticks from the given time
The number of ticks to calculate
The time to get the next tick from
The duration of the number of ticks from the given time in seconds
Returns the tick value at the time. Takes into account any automation curves scheduled on the signal.
The time to get the tick count at
The number of ticks which have elapsed at the time given any automations.
Given a tick, returns the time that tick occurs at.
The time that the tick occurs.
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.
this
const delay = new Tone.FeedbackDelay(0.5, 0.98).toDestination();
// a short burst of noise through the feedback delay
const noise = new Tone.Noise().connect(delay).start().stop("+0.1");
// making the delay time shorter over time will also make the pitch rise
delay.delayTime.linearRampTo(0.01, 20);
Schedules a linear continuous change in parameter value from the previous scheduled parameter value to the given value.
ProtectedlogPrints the outputs to the console log for debugging purposes.
Prints the contents only if either the object has a property
called debug set to true, or a variable called TONE_DEBUG_CLASS
is set to the name of the class.
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
Set multiple properties at once with an object.
Replace the Param's internal AudioParam. Will apply scheduled curves onto the parameter and replace the connections.
Creates a schedule point with the current value at the current time.
Automation methods like linearRampToValueAtTime and exponentialRampToValueAtTime
require a starting automation value usually set by setValueAtTime. This method
is useful since it will do a setValueAtTime with whatever the currently computed
value at the given time is.
When to add a ramp point.
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.
Convert some number of ticks their the duration in seconds accounting for any automation curves starting at the given time.
The number of ticks to convert to seconds.
When along the automation timeline to convert the ticks.
The duration in seconds of the ticks.
The inverse of ticksToTime. Convert a duration in seconds to the corresponding number of ticks accounting for any automation curves starting at the given time.
The duration in ticks.
Convert the incoming time to seconds. This is calculated against the current TransportClass bpm
Optionaltime: TimeConvert the input time into ticks
Optionaltime: Time | TimeClass<number, TimeBaseUnit>StaticgetReturns all of the default options belonging to the class.
A Param class just for computing ticks. Similar to the Param class, but offers conversion to BPM values as well as ability to compute tick duration and elapsed ticks