The base type of the oscillator. See Oscillator.baseType

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "fmsquare4");
omniOsc.sourceType; // 'fm'
omniOsc.baseType; // 'square'
omniOsc.partialCount; // 4

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.

The number of detuned oscillators when sourceType === "fat". See FatOscillator.count

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.

Harmonicity is the frequency ratio between the carrier and the modulator oscillators. See AMOscillator or FMOscillator

Sources have no inputs

The modulationFrequency Signal of the oscillator when sourceType === "pwm" see PWMOscillator

The modulation index when the sourceType === "fm" See FMOscillator.

The type of the modulator oscillator. Only if the oscillator is set to "am" or "fm" types. See AMOscillator or FMOscillator

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

The value is an empty array when the type is not "custom". This is not available on "pwm" and "pulse" oscillator types. See Oscillator.partials

The duration in seconds of one sample.

The source type of the oscillator.

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "fmsquare");
console.log(omniOsc.sourceType); // 'fm'

The detune spread between the oscillators when sourceType === "fat". See FatOscillator.count

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 type of the oscillator. Can be any of the basic types: sine, square, triangle, sawtooth. Or prefix the basic types with "fm", "am", or "fat" to use the FMOscillator, AMOscillator or FatOscillator types. The oscillator could also be set to "pwm" or "pulse". All of the parameters of the oscillator's class are accessible when the oscillator is set to that type, but throws an error when it's not.

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator().toDestination().start();
omniOsc.type = "pwm";
// modulationFrequency is parameter which is available
// only when the type is "pwm".
omniOsc.modulationFrequency.value = 0.5;

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator().toDestination().start();
// an square wave frequency modulated by a sawtooth
omniOsc.type = "fmsquare";
omniOsc.modulationType = "sawtooth";

The version number semver

The volume of the output in decibels.

import { PWMOscillator } from "tone";
const source = new PWMOscillator().toDestination();
source.volume.value = -6;

The width of the oscillator when sourceType === "pulse". See PWMOscillator.width

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "pulse");
// can access the width attribute only if type === "pulse"
omniOsc.width.value = 0.2;