Class: LFO

Extends

• Tone

Members

<private> _connect

pointer to the parent's connect method

Source:

• Tone.js, line 2110

isFrequency

true if the input is in the format number+hz i.e.: 10hz

Inherited From:

• Tone#isFrequency

Source:

• Tone.js, line 1700

isNotation

tests if a string is musical notation i.e.: 4n = quarter note 2m = two measures 8t = eighth-note triplet

Inherited From:

• Tone#isNotation

Source:

• Tone.js, line 1672

isTransportTime

tests if a string is transportTime i.e. : 1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes

Inherited From:

• Tone#isTransportTime

Source:

• Tone.js, line 1686

oscillator :Tone.Oscillator

Type:

• Tone.Oscillator

Source:

• Tone.js, line 2031

scaler :Tone.Scale

Type:

• Tone.Scale

Source:

• Tone.js, line 2033

Methods

connect(param)

override the connect method so that it 0's out the value if attached to an AudioParam

Parameters:

Name	Type	Description
param	AudioNode | AudioParam | Tone

Source:

• Tone.js, line 2119

notationToSeconds(notation, bpm, timeSignature) → {number}

convert notation format strings to seconds

Parameters:

Name	Type	Argument	Description
notation	string
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#notationToSeconds

Source:

• Tone.js, line 1715

Returns:

Type

number

receive(channelName)

recieve the input from the desired channelName to the input gain of 'this' node.

Parameters:

Name	Type	Description
channelName	string

Inherited From:

• Tone#receive

Source:

• Tone.js, line 2558

send(channelName, amount) → {GainNode}

send signal to a channel name

Parameters:

Name	Type	Description
channelName	string
amount	number

Inherited From:

• Tone#send

Source:

• Tone.js, line 2543

Returns:

Type

GainNode

setFrequency(rate)

set the frequency

Parameters:

Name	Type	Description
rate	number

Source:

• Tone.js, line 2078

setMax(min)

set the maximum output of the LFO

Parameters:

Name	Type	Description
min	number

Source:

• Tone.js, line 2094

setMin(min)

set the minimum output of the LFO

Parameters:

Name	Type	Description
min	number

Source:

• Tone.js, line 2086

setType(type)

set the waveform of the LFO

Parameters:

Name	Type	Description
type	string

Source:

• Tone.js, line 2102

start(time)

start the LFO

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2046

stop(time)

stop the LFO

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2054

sync()

Sync the start/stop/pause to the transport and the frequency to the bpm of the transport

Source:

• Tone.js, line 2062

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone#toFrequency

Source:

• Tone.js, line 1796

Returns:

the time in hertz

Type

number

toSeconds(time, bpm, timeSignature)

convert Tone.Time into seconds unlike the method which it overrides, this takes into account transporttime and musical notation

Parameters:

Name	Type	Argument	Description
time	Tone.Time
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 1816

toTransportTime(seconds, bpm, timeSignature) → {string}

Convert seconds to the closest transportTime in the form measures:quarters:sixteenths

Parameters:

Name	Type	Argument	Description
seconds	Tone.Time
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#toTransportTime

Source:

• Tone.js, line 1777

Returns:

Type

string

transportTimeToSeconds(transportTime, bpm, timeSignature) → {number}

convert transportTime into seconds i.e.: 4:2:3 == 4 measures + 2 quarters + 3 sixteenths

Parameters:

Name	Type	Argument	Description
transportTime	string
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#transportTimeToSeconds

Source:

• Tone.js, line 1747

Returns:

seconds

Type

number

unsync()

unsync the LFO from transport control

Source:

• Tone.js, line 2069