Tone.Vibrato

↳ EXTENDS Tone.Effect

A Vibrato effect composed of a Tone.Delay and a Tone.LFO. The LFO modulates the delayTime of the delay, causing the pitch to rise and fall.

CONSTRUCTOR

new Tone.Vibrato (
frequency
,
depth
)
frequency

The frequency of the vibrato.

depth

The amount the pitch is modulated.

DEFAULTS

{
maxDelay : 0.005 ,
frequency : 5 ,
depth : 0.1 ,
type : sine
}

Members

.depth

NormalRange #

The depth of the vibrato.

</>

.frequency

Frequency #

The frequency of the vibrato

</>

.type

string #

Type of oscillator attached to the Vibrato.

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
inherited from Tone.Effect

.wet

NormalRange #

The wet control is how much of the effected will pass through to the output. 1 = 100% effected signal, 0 = 100% dry signal.

</>

Methods

.dispose ( )

#
↪ returns Tone.Vibrato

this

Clean up.

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

.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();
</>
docs generated Sep 15 2019