Tone.PulseOscillator

↳ EXTENDS Tone.Source

Tone.PulseOscillator is a pulse oscillator with control over pulse width, also known as the duty cycle. At 50% duty cycle (width = 0.5) the wave is a square and only odd-numbered harmonics are present. At all other widths even-numbered harmonics are present. Read more here.

CONSTRUCTOR

new Tone.PulseOscillator ( [
frequency
] , [
width
] )
frequency

The frequency of the oscillator

optional
width

The width of the pulse

optional

DEFAULTS

{
frequency : 440 ,
detune : 0 ,
phase : 0 ,
width : 0.2
}

EXAMPLE

var pulse = new Tone.PulseOscillator("E5", 0.4).toMaster().start();

Members

.phase

↝ Degrees #

The phase of the oscillator in degrees.

</>
∿

.detune

↝ Cents #

The detune in cents.

</>
∿

.width

↝ NormalRange #

The width of the pulse.

</>

.type

↝ string READONLY #

The type of the oscillator. Always returns “pulse”.

</>
∿

.frequency

↝ Frequency #

The frequency control.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

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

</>
↳ inherited from Tone.Source

.fadeOut

↝ Time #

The fadeOut time of the amplitude envelope.

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

</>

Methods

.dispose ( )

#
↪ returns Tone.PulseOscillator

this

Clean up method.

</>
↳ 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

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

.connect ( )

#
unit
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.Source

.unsync ( )

#
↪ returns Tone.Source

this

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

</>
↳ 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

.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

.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