Oscillator supports a number of features including phase rotation, multiple oscillator types (see Oscillator.type), and Transport syncing (see Oscillator.syncFrequency).
import { Oscillator } from "tone";
// make and start a 440hz sine tone
const osc = new Oscillator(440, "sine").toDestination().start();
The oscillator type without the partialsCount appended to the end
import { Oscillator } from "tone";
const osc = new Oscillator();
osc.type = "sine2";
console.log(osc.baseType); // "sine"
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.
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.
Mute the output.
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// mute the output
osc.mute = true;
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
The callback to invoke when the source is stopped.
'partialCount' offers an alternative way to set the number of used partials. When partialCount is 0, the maximum number of partials are used when representing the waveform using the periodicWave. When 'partials' is set, this value is not settable, but equals the length of the partials array. A square wave wave is composed of only odd harmonics up through the harmonic series. Partial count can limit the number of harmonics which are used to generate the waveform.
import { Oscillator } from "tone";
const osc = new Oscillator("C3", "square").toDestination().start();
osc.partialCount = 5;
The partials describes the relative amplitude of each of the harmonics of the oscillator. The first value in the array is the first harmonic (i.e. the fundamental frequency), the second harmonic is an octave up, the third harmonic is an octave and a fifth, etc. The resulting oscillator output is composed of a sine tone at the relative amplitude at each of the harmonic intervals.
import { Oscillator } from "tone";
const osc = new Oscillator("F3").toDestination().start();
osc.partials = [1, 0, 0.4, 1, 0.2];
The phase is the starting position within the oscillator's cycle. For example a phase of 180 would start halfway through the oscillator's cycle.
The duration in seconds of one sample.
Returns the playback state of the source, either "started" or "stopped".
import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3", () => {
player.start();
console.log(player.state);
}).toDestination();
The oscillator's type. Also capable of setting the first x number of partials of the oscillator. For example: "sine4" would set be the first 4 partials of the sine wave and "triangle8" would set the first 8 partials of the triangle wave.
import { Oscillator } from "tone";
const osc = new Oscillator();
osc.type = "sine2";
The version number semver
The volume of the output in decibels.
import { PWMOscillator } from "tone";
const source = new PWMOscillator().toDestination();
source.volume.value = -6;
Returns an array of values which represents the waveform.
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
The output to connect from
The input to connect to
disconnect the output
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.
Returns the initial value of the oscillator when stopped. E.g. a "sine" oscillator with phase = 90 would return an initial value of -1.
Return the current time of the Context clock without any lookAhead.
Return the current time of the Context clock plus the lookAhead.
Restart the oscillator. Does not stop the oscillator, but instead just cancels any scheduled 'stop' from being invoked.
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"
});
Start the source at the specified time. If no time is given, start the source now.
import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start("+0.5"); // starts the source 0.5 seconds from now
Stop the source at the specified time. If no time is given, stop the source now.
import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
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.
import { Oscillator, Transport } from "tone";
const osc = new Oscillator().toDestination();
// sync the source so that it plays between 0 and 0.3 on the Transport's timeline
osc.sync().start(0).stop(0.3);
// start the transport.
Transport.start();
// set it to loop once a second
Transport.loop = true;
Transport.loopEnd = 1;
Sync the signal to the Transport's bpm. Any changes to the transports bpm, will also affect the oscillators frequency.
import { Oscillator, Transport } from "tone";
const osc = new Oscillator().toDestination().start();
osc.frequency.value = 440;
// the ratio between the bpm and the frequency will be maintained
osc.syncFrequency();
// double the tempo
Transport.bpm.value *= 2;
// the frequency of the oscillator is doubled to 880
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
Unsync the source to the Transport. See Source.sync
Unsync the oscillator's frequency from the Transport. See Oscillator.syncFrequency