Wrapper around the native fire-and-forget OscillatorNode. Adds the ability to reschedule the stop method. Oscillator is better for most use-cases



new ToneOscillatorNode (
frequency:Frequency ,

The frequency value


The basic oscillator type

) => ToneOscillatorNode
new ToneOscillatorNode (
options?:Partial<ToneOscillatorNodeOptions >
) => ToneOscillatorNode


blockTime #

readonly Seconds

The number of seconds of 1 processing block (128 samples)


channelCount #


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 #


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 #


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".

context #


The context belonging to the node.

debug #


Set this debug flag to log all events that happen in this class.

detune #

Param<"cents" >

The detune of the oscillator

disposed #

readonly boolean

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.

frequency #

Param<"frequency" >

The frequency of the oscillator

input #


Sources do not have input nodes

numberOfInputs #

readonly number

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

const node = new Tone.Gain();

numberOfOutputs #

readonly number

The number of outputs of the AudioNode.

const node = new Tone.Gain();

onended #


The callback to invoke after the source is done playing.

output #


The public output node

sampleTime #

readonly Seconds

The duration in seconds of one sample.


state #

readonly BasicPlaybackState

Get the playback state at the current time

type #


The oscillator type. Either 'sine', 'sawtooth', 'square', or 'triangle'

static version #


The version number semver


cancelStop #

Cancel a scheduled stop event

cancelStop ( ) => this

chain #

Connect the output of this node to the rest of the nodes in series.

const player = new Tone.Player("");
player.autostart = true;
const filter = new Tone.AutoFilter(4).start();
const distortion = new Tone.Distortion(0.5);
// connect the player to the filter, distortion and then to the master output
player.chain(filter, distortion, Tone.Destination);
chain (
...nodes:InputNode []
) => this

connect #

connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

connect (
destination:InputNode ,

The output to connect to

outputNum= 0:number ,

The output to connect from

inputNum= 0:number

The input to connect to

) => this

disconnect #

disconnect the output

disconnect (
destination?:InputNode ,
outputNum= 0:number ,
inputNum= 0:number
) => this

dispose #

Clean up.

dispose ( ) => this

fan #

connect the output of this node to the rest of the nodes in parallel.

const player = new Tone.Player("");
player.autostart = true;
const pitchShift = new Tone.PitchShift(4).toDestination();
const filter = new Tone.Filter("G5").toDestination();
// connect a node to the pitch shift and filter in parallel, filter);
fan (
...nodes:InputNode []
) => this

get #

Get the object's attributes.

const osc = new Tone.Oscillator();

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => ToneOscillatorNodeOptions

getStateAtTime #

Get the playback state at the given time

getStateAtTime (
) => BasicPlaybackState

immediate #

Return the current time of the Context clock without any lookAhead.

setInterval(() => {
}, 100);
immediate ( ) => Seconds

now #

Return the current time of the Context clock plus the lookAhead.

setInterval(() => {
}, 100);
now ( ) => Seconds

set #

Set multiple properties at once with an object.

const filter = new Tone.Filter();
// set values using an object
	frequency: 300,
	type: "highpass"

setPeriodicWave #

Sets an arbitrary custom periodic waveform given a PeriodicWave.

setPeriodicWave (

PeriodicWave should be created with context.createPeriodicWave

) => this

start #

Start the oscillator node at the given time

start (

When to start the oscillator

) => this

stop #

Stop the source node at the given time.

stop (

When to stop the source

) => this

toDestination #

Connect the output to the context's destination node.

const osc = new Tone.Oscillator("C2").start();
toDestination ( ) => this

toFrequency #

Convert the input to a frequency number

const gain = new Tone.Gain();
toFrequency (
) => Hertz


Connect the output to the context's destination node. See toDestination

toMaster ( ) => this

toSeconds #

Convert the incoming time to seconds

const gain = new Tone.Gain();
toSeconds (
) => Seconds

toString #

Convert the class to a string

const osc = new Tone.Oscillator();
toString ( ) => string

toTicks #

Convert the input time into ticks

const gain = new Tone.Gain();
toTicks (
time?:Time | TimeClass
) => Ticks