Tone.Oscillator

↳ EXTENDS Tone.Source

Tone.Oscillator supports a number of features including phase rotation, multiple oscillator types (see Tone.Oscillator.type), and Transport syncing (see Tone.Oscillator.syncFrequency).

CONSTRUCTOR

new Tone.Oscillator ( [
frequency
] , [
type
] )
frequency

Starting frequency

optional
type

The oscillator type. Read more about type below.

type: string
optional

DEFAULTS

{
type : sine ,
frequency : 440 ,
detune : 0 ,
phase : 0 ,
partials : [] ,
partialCount : 0
}

EXAMPLE

//make and start a 440hz sine tone
var osc = new Tone.Oscillator(440, "sine").toMaster().start();

Members

.partials

Array #

The partials of the waveform. A partial represents the amplitude at a harmonic. The first harmonic is the fundamental frequency, the second is the octave and so on following the harmonic series. Setting this value will automatically set the type to “custom”. The value is an empty array when the type is not “custom”.

EXAMPLE

osc.partials = [1, 0.2, 0.01];
</>

.phase

Degrees #

The phase of the oscillator in degrees.

EXAMPLE

osc.phase = 180; //flips the phase of the oscillator
</>

.type

string #

The type of the oscillator: either sine, square, triangle, or sawtooth. 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.

Uses PeriodicWave internally even for native types so that it can set the phase. PeriodicWave equations are from the Webkit Web Audio implementation.

EXAMPLE

//set it to a square wave
osc.type = "square";

EXAMPLE

//set the first 6 partials of a sawtooth wave
osc.type = "sawtooth6";
</>

.baseType

string #

The oscillator type without the partialsCount appended to the end

EXAMPLE

osc.type = 'sine2'
osc.baseType //'sine'
osc.partialCount = 2
</>

.detune

Cents #

The detune control signal.

</>

.frequency

Frequency #

The frequency control.

</>

.partialCount

Number #

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

EXAMPLE

osc.type = 'sine'
osc.partialCount = 3
//is equivalent to
osc.type = 'sine3'
</>
inherited from Tone.AudioNode

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

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
inherited from Tone.AudioNode

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

</>
inherited from Tone.AudioNode

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

</>
inherited from Tone.AudioNode

.numberOfInputs

Number READONLY #

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

</>
inherited from Tone.AudioNode

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

</>
inherited from Tone.Source

.volume

Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;
</>
inherited from Tone.Source

.fadeIn

Time #

The fadeIn time of the amplitude envelope.

</>
inherited from Tone.Source

.fadeOut

Time #

The fadeOut time of the amplitude envelope.

</>
inherited from Tone.Source

.mute

boolean #

Mute the output.

EXAMPLE

//mute the output
source.mute = true;
</>
inherited from Tone.Source

.state

Tone.State READONLY #

Returns the playback state of the source, either “started” or “stopped”.

</>

Methods

.get ( )

#
↪ returns Object

Get the object’s attributes. Given no arguments get will return all available object properties and their corresponding values.

</>

.restart ( )

#
time
type: Time
optional
↪ returns Tone.Oscillator

this

Restart the oscillator. Does not stop the oscillator, but instead just cancels any scheduled ‘stop’ from being invoked.

</>

.unsyncFrequency ( )

#
↪ returns Tone.Oscillator

this

Unsync the oscillator’s frequency from the Transport. See Tone.Oscillator.syncFrequency

</>

.syncFrequency ( )

#
↪ returns Tone.Oscillator

this

Sync the signal to the Transport’s bpm. Any changes to the transports bpm, will also affect the oscillators frequency.

EXAMPLE

Tone.Transport.bpm.value = 120;
osc.frequency.value = 440;
//the ration between the bpm and the frequency will be maintained
osc.syncFrequency();
Tone.Transport.bpm.value = 240;
// the frequency of the oscillator is doubled to 880
</>

.dispose ( )

#
↪ returns Tone.Oscillator

this

Dispose and disconnect.

</>
inherited from Tone.AudioNode

.chain ( )

#
nodes
↪ returns Tone.AudioNode

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);
 
</>
inherited from Tone.AudioNode

.connect ( )

#
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

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

</>
inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.

↪ returns Tone.AudioNode

this

disconnect the output

</>
inherited from Tone.AudioNode

.fan ( )

#
nodes
↪ returns Tone.AudioNode

this

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

</>
inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

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();
</>
inherited from Tone.Source

.stop ( )

#
time

When the source should be stopped.

type: Time
default: now
↪ returns Tone.Source

this

Stop the source at the specified time. If no time is given, stop the source now.

EXAMPLE

source.stop(); // stops the source immediately
</>
inherited from Tone.Source

.start ( )

#
time

When the source should be started.

type: Time
default: now
↪ returns Tone.Source

this

Start the source at the specified time. If no time is given, start the source now.

EXAMPLE

source.start("+0.5"); //starts the source 0.5 seconds from now
</>
inherited from Tone.Source

.unsync ( )

#
↪ returns Tone.Source

this

Unsync the source to the Transport. See Tone.Source.sync

</>
inherited from Tone.Source

.sync ( )

#
↪ returns Tone.Source

this

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.

EXAMPLE

//sync the source so that it plays between 0 and 0.3 on the Transport's timeline
source.sync().start(0).stop(0.3);
//start the transport.
Tone.Transport.start();

 

EXAMPLE

//start the transport with an offset and the sync'ed sources
//will start in the correct position
source.sync().start(0.1);
//the source will be invoked with an offset of 0.4
Tone.Transport.start("+0.5", 0.5);
</>
docs generated Sep 15 2019