Adds the ability to synchronize the signal to the Transport
Initial value of the signal
The unit name, e.g. "frequency"
The number of seconds of 1 processing block (128 samples)
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.
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 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".
The 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.
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
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
True if the signal value is being overridden by a connected signal. Internal use only.
Don't override when something is connected to the input
The duration in seconds of one sample.
The current value of the parameter. Setting this value is equivalent to setValueAtTime(value, context.currentTime)
The version number semver
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.
Connect the output of this node to the rest of the nodes in series.
import { Destination, Filter, Oscillator, Volume } from "tone";
const osc = new Oscillator().start();
const filter = new Filter();
const volume = new Volume(-8);
// connect a node to the filter, volume and then to the master output
osc.chain(filter, volume, Destination);
connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode
disconnect the output
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'
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// exponential approach over 4 seconds starting in 1 second
osc.frequency.exponentialApproachValueAtTime("C4", "+1", 4);
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.
import { FeedbackDelay, Noise } from "tone";
const delay = new FeedbackDelay(0.5, 0.98).toDestination();
// a short burst of noise through the feedback delay
const noise = new 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.
connect the output of this node to the rest of the nodes in parallel.
Get the object's attributes.
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
Returns all of the default options belonging to the class.
Get the signals value at the given time. Subsequent scheduling may invalidate the returned value.
import { now, Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// set the frequency to "G4" in exactly 1 second from now.
osc.frequency.setValueAtTime("G4", "+1");
setInterval(() => {
// check the value every 100 ms
osc.frequency.getValueAtTime(now());
}, 100);
Return the current time of the Context clock without any lookAhead.
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.
import { FeedbackDelay, Noise } from "tone";
const delay = new FeedbackDelay(0.5, 0.98).toDestination();
// a short burst of noise through the feedback delay
const noise = new Noise().connect(delay).start().stop("+0.1");
// linearly ramp to the value 4 over 3 seconds.
delay.delayTime.linearRampTo(4, 3);
Schedules a linear continuous change in parameter value from the previous scheduled parameter value to the given value.
Return the current time of the Context clock plus the lookAhead.
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
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// schedule it to ramp either linearly or exponentially depending on the units
osc.frequency.rampTo("A2", 10);
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// schedule it to ramp starting at a specific time
osc.frequency.rampTo("A2", 10, "+2");
Set multiple properties at once with an object.
import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
frequency: 300,
type: "highpass"
});
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.
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// set the frequency to "G4" in exactly 1 second from now.
osc.frequency.setRampPoint("+1");
osc.frequency.linearRampToValueAtTime("C1", "+2");
Start exponentially approaching the target value at the given time with a rate having the given time constant.
Schedules a parameter value change at the given time.
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// set the frequency to "G4" in exactly 1 second from now.
osc.frequency.setValueAtTime("G4", "+1");
Sets an array of arbitrary parameter values starting at the given time for the given duration.
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.
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
osc.frequency.targetRampTo("C4", 4);
Connect the output to the context's destination node.
Convert the input to a frequency number
Connect the output to the context's destination node. See toDestination
Convert the incoming time to seconds
Convert the class to a string
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
Convert the input time into ticks