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.

• "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
• "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
• "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

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.

The detune value in cents (100th of a semitone).

import { now, PulseOscillator } from "tone";
const osc = new PulseOscillator("F3").toDestination().start();
// pitch it 1 octave = 12 semitones = 1200 cents
osc.detune.setValueAtTime(-1200, now());
osc.detune.setValueAtTime(1200, now() + 0.5);
osc.detune.linearRampToValueAtTime(0, now() + 1);
osc.stop(now() + 1.5);

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 frequency value of the oscillator

import { FMOscillator } from "tone";
const osc = new FMOscillator("Bb4").toDestination().start();
osc.frequency.rampTo("D2", 3);

Harmonicity is the frequency ratio between the carrier and the modulator oscillators. A harmonicity of 1 gives both oscillators the same frequency. Harmonicity = 2 means a change of an octave.

import { FMOscillator } from "tone";
const fmOsc = new FMOscillator("D2").toDestination().start();
// pitch the modulator an octave below carrier
fmOsc.harmonicity.value = 0.5;

Sources have no inputs

The modulation index which is in essence the depth or amount of the modulation. In other terms it is the ratio of the frequency of the modulating signal (mf) to the amplitude of the modulating signal (ma) -- as in ma/mf.

The type of the modulator oscillator

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.

The output note

'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;