Tone.OscillatorNode
↳ EXTENDS Tone.AudioNodeWrapper around the native fire-and-forget OscillatorNode. Adds the ability to reschedule the stop method. Tone.Oscillator is better for most use-cases
CONSTRUCTOR
new Tone.OscillatorNode (The buffer to play
The callback to invoke when the buffer is done playing.
DEFAULTS
Members
.state
↝ Tone.State READONLY #Returns the playback state of the oscillator, either “started” or “stopped”.
.channelCount
↝ Number READONLY #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.
.numberOfInputs
↝ Number READONLY #The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
.channelCountMode
↝ String READONLY #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
↝ String READONLY #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
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.numberOfOutputs
↝ Number READONLY #The number of outputs coming out of the AudioNode.
Methods
.getStateAtTime ( )
#The time to test the state at
The playback state.
Get the playback state at the given time
.setPeriodicWave ( )
#PeriodicWave should be created with context.createPeriodicWave
this
Sets an arbitrary custom periodic waveform given a PeriodicWave.
.start ( )
#When to start the oscillator
this
Start the oscillator node at the given time
.stop ( )
#When to stop the oscillator
this
Stop the oscillator node at the given time
.toMaster ( )
#this
Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)
EXAMPLE
//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();.chain ( )
#this
Connect the output of this node to the rest of the nodes in series.
EXAMPLE
//connect a node to an effect, panVol and then to the master output
node.chain(effect, panVol, Tone.Master);
.connect ( )
#optionally which output to connect from
optionally which input to connect to
this
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
.disconnect ( )
#Either the output index to disconnect if the output is an array, or the node to disconnect from.
this
disconnect the output
.fan ( )
#this
connect the output of this node to the rest of the nodes in parallel.