Tone.js Class: LFO

new LFO(rate, outputMin, outputMax)

Low Frequency Oscillator

LFO produces an output signal which can be attached to an AudioParam for constant control over that parameter the LFO can also be synced to the transport

Parameters:

Name	Type	Argument
`rate`	number
`outputMin`	number	<optional>
`outputMax`	number	<optional>

Source:

Tone.js, line 2470

Extends

Tone

Members

connect

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

Source:

Tone.js, line 2567

input :GainNode

Type:

GainNode

Source:

Tone.js, line 2472

oscillator :Tone.Oscillator

Type:

Tone.Oscillator

Source:

Tone.js, line 2474

output

alias for the output

Source:

Tone.js, line 2481

Methods

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam \| Tone	<repeatable>

Inherited From:

Tone#chain

Source:

Tone.js, line 167

dbToGain(db) → {number}

convert db scale to gain scale (0-1)

Parameters:

Name	Type	Description
`db`	number

Inherited From:

Tone#dbToGain

Source:

Tone.js, line 226

Returns:

Type: number

defaultArg(given, fallback) → {*}

if a the given is undefined, use the fallback

Parameters:

Name	Type	Description
`given`	*
`fallback`	*

Inherited From:

Tone#defaultArg

Source:

Tone.js, line 189

Returns:

Type: *

disconnect()

disconnect the output

Inherited From:

Tone#disconnect

Source:

Tone.js, line 159

dispose()

disconnect and dispose

Source:

Tone.js, line 2572

equalPowerScale(percent) → {number}

equal power gain scale good for cross-fading

Parameters:

Name	Type	Description
`percent`	number	(0-1)

Inherited From:

Tone#equalPowerScale

Source:

Tone.js, line 200

Returns:

output gain (0-1)

Type: number

expScale(gain) → {number}

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Inherited From:

Tone#expScale

Source:

Tone.js, line 217

Returns:

gain (decibel scale but betwee 0-1)

Type: number

frequencyToSeconds(freq) → {number}

convert a frequency into seconds accepts both numbers and strings i.e. 10hz or 10 both equal .1

Parameters:

Name	Type	Description
`freq`	number \| string

Inherited From:

Tone#frequencyToSeconds

Source:

Tone.js, line 345

Returns:

Type: number

gainToDb(gain) → {number}

convert gain scale to decibels

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Inherited From:

Tone#gainToDb

Source:

Tone.js, line 235

Returns:

Type: number

interpolate(input, outputMin, outputMax) → {number}

interpolate the input value (0-1) to be between outputMin and outputMax

Parameters:

Name	Type	Description
`input`	number
`outputMin`	number
`outputMax`	number

Inherited From:

Tone#interpolate

Source:

Tone.js, line 246

Returns:

Type: number

logScale(gain) → {number}

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Inherited From:

Tone#logScale

Source:

Tone.js, line 209

Returns:

gain (decibel scale but betwee 0-1)

Type: number

noGC()

makes a connection to ensure that the node will not be garbage collected until 'dispose' is explicitly called

use carefully. circumvents JS and WebAudio's normal Garbage Collection behavior

Inherited From:

Tone#noGC

Source:

Tone.js, line 483

normalize(input, inputMin, inputMax) → {number}

normalize the input to 0-1 from between inputMin to inputMax

Parameters:

Name	Type	Description
`input`	number
`inputMin`	number
`inputMax`	number

Inherited From:

Tone#normalize

Source:

Tone.js, line 257

Returns:

Type: number

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

convert notation format strings to seconds

Parameters:

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

Inherited From:

Tone#notationToSeconds

Source:

Tone.js, line 2070

Returns:

Type: number

now() → {number}

Inherited From:

Tone#now

Source:

Tone.js, line 284

Returns:

the currentTime from the AudioContext

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 3209

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
`samples`	number

Inherited From:

Tone#samplesToSeconds

Source:

Tone.js, line 293

Returns:

Type: number

secondsToFrequency(seconds) → {number}

convert a number in seconds to a frequency

Parameters:

Name	Type	Description
`seconds`	number

Inherited From:

Tone#secondsToFrequency

Source:

Tone.js, line 354

Returns:

Type: number

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 3194

Returns:

Type: GainNode

setFrequency(rate)

set the frequency

Parameters:

Name	Type	Description
`rate`	number

Source:

Tone.js, line 2527

setMax(min)

set the maximum output of the LFO

Parameters:

Name	Type	Description
`min`	number

Source:

Tone.js, line 2543

setMin(min)

set the minimum output of the LFO

Parameters:

Name	Type	Description
`min`	number

Source:

Tone.js, line 2535

setType(type)

set the waveform of the LFO

Parameters:

Name	Type	Description
`type`	string

Source:

Tone.js, line 2551

start(time)

start the LFO

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

Tone.js, line 2493

stop(time)

stop the LFO

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

Tone.js, line 2501

sync()

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

Source:

Tone.js, line 2509

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
`time`	Tone.Time

Inherited From:

Tone#toFrequency

Source:

Tone.js, line 2157

Returns:

the time in hertz

Type: number

toMaster()

connect 'this' to the master output

Inherited From:

Tone#toMaster

Source:

Tone.js, line 454

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
`time`	Tone.time

Inherited From:

Tone#toSamples

Source:

Tone.js, line 303

Returns:

Type: number

toSeconds(time, now) → {number}

convert Tone.Time to seconds

this is a simplified version which only handles numbers and 'now' relative numbers. If the Transport is included this method is overridden to include many other features including notationTime, Frequency, and transportTime