Tone.Tremolo

↳ EXTENDS Tone.StereoEffect

Tone.Tremolo modulates the amplitude of an incoming signal using a Tone.LFO. The type, frequency, and depth of the LFO is controllable.

CONSTRUCTOR

new Tone.Tremolo ( [
frequency
] , [
depth
] )
frequency

The rate of the effect.

optional
depth

The depth of the effect.

optional

DEFAULTS

{
frequency : 10 ,
type : sine ,
depth : 0.5 ,
spread : 180
}

EXAMPLE

//create a tremolo and start it's LFO
var tremolo = new Tone.Tremolo(9, 0.75).toMaster().start();
//route an oscillator through the tremolo and start it
var oscillator = new Tone.Oscillator().connect(tremolo).start();

Members

∿

.depth

↝ NormalRange #

The depth of the effect. A depth of 0, has no effect on the amplitude, and a depth of 1 makes the amplitude modulate fully between 0 and 1.

</>
∿

.frequency

↝ Frequency #

The frequency of the tremolo.

</>

.spread

↝ Degrees #

Amount of stereo spread. When set to 0, both LFO’s will be panned centrally. When set to 180, LFO’s will be panned hard left and right respectively.

</>

.type

↝ string #

The Tremolo’s oscillator type.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.StereoEffect
∿

.wet

↝ NormalRange #

The wet control, i.e. how much of the effected will pass through to the output.

</>

Methods

.unsync ( )

#
↪ returns Tone.Tremolo

this

Unsync the filter from the transport

</>

.start ( )

#
time

When the tremolo begins.

type: Time
default: now
↪ returns Tone.Tremolo

this

Start the tremolo.

</>

.stop ( )

#
time

When the tremolo stops.

type: Time
default: now
↪ returns Tone.Tremolo

this

Stop the tremolo.

</>

.sync ( )

#
delay

Delay time before starting the effect after the Transport has started.

type: Time
default: 0
↪ returns Tone.AutoFilter

this

Sync the effect to the transport.

</>

.dispose ( )

#
↪ returns Tone.Tremolo

this

clean up

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

</>
docs generated Sep 15 2019