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:

component/LFO.js, line 16

Extends

Tone

Members

<private> _connect

pointer to the parent's connect method

Source:

component/LFO.js, line 103

<private> _scaler :Tone.Scale

Type:

Tone.Scale

Source:

component/LFO.js, line 25

bufferSize :number

the default buffer size

Type:

number

Inherited From:

Tone#bufferSize

Source:

core/Tone.js, line 138

connect

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

Source:

component/LFO.js, line 111

context :AudioContext

A static pointer to the audio context

Type:

AudioContext

Inherited From:

Tone#context

Source:

core/Tone.js, line 132

input :GainNode

Type:

GainNode

Source:

component/LFO.js, line 18

isFrequency

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

Inherited From:

Tone#isFrequency

Source:

core/Transport.js, line 706

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:

core/Transport.js, line 678

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:

core/Transport.js, line 692

oscillator :Tone.Oscillator

Type:

Tone.Oscillator

Source:

component/LFO.js, line 20

output

alias for the output

Source:

component/LFO.js, line 27

Methods

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam \| Tone	<repeatable>

Inherited From:

Tone#chain

Source:

core/Tone.js, line 163

dbToGain(db) → {number}

convert db scale to gain scale (0-1)

Parameters:

Name	Type	Description
`db`	number

Inherited From:

Tone#dbToGain

Source:

core/Tone.js, line 222

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:

core/Tone.js, line 185

Returns:

Type: *

disconnect()

disconnect the output

Inherited From:

Tone#disconnect

Source:

core/Tone.js, line 155

dispose()

disconnect and dispose

Source:

component/LFO.js, line 116

equalPowerScale(percent) → {number}

equal power gain scale good for cross-fading

Parameters:

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

Inherited From:

Tone#equalPowerScale

Source:

core/Tone.js, line 196

Returns:

output gain (0-1)

Type: number

expScale(gain) → {number}

Parameters:

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

Inherited From:

Tone#expScale

Source:

core/Tone.js, line 213

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:

core/Tone.js, line 341

Returns:

Type: number

gainToDb(gain) → {number}

convert gain scale to decibels

Parameters:

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

Inherited From:

Tone#gainToDb

Source:

core/Tone.js, line 231

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:

core/Tone.js, line 242

Returns:

Type: number

logScale(gain) → {number}

Parameters:

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

Inherited From:

Tone#logScale

Source:

core/Tone.js, line 205

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:

core/Master.js, line 95

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:

core/Tone.js, line 253

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:

core/Transport.js, line 721

Returns:

Type: number

now() → {number}

Inherited From:

Tone#now

Source:

core/Tone.js, line 280

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:

core/Bus.js, line 38

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
`samples`	number

Inherited From:

Tone#samplesToSeconds

Source:

core/Tone.js, line 289

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:

core/Tone.js, line 350

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:

core/Bus.js, line 23

Returns:

Type: GainNode

setFrequency(rate)

set the frequency

Parameters:

Name	Type	Description
`rate`	number

Source:

component/LFO.js, line 71

setMax(min)

set the maximum output of the LFO

Parameters:

Name	Type	Description
`min`	number

Source:

component/LFO.js, line 87

setMin(min)

set the minimum output of the LFO

Parameters:

Name	Type	Description
`min`	number

Source:

component/LFO.js, line 79

setType(type)

set the waveform of the LFO

Parameters:

Name	Type	Description
`type`	string

Source:

component/LFO.js, line 95

start(time)

start the LFO

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

component/LFO.js, line 39

stop(time)

stop the LFO

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

component/LFO.js, line 47

sync()

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

Source:

component/LFO.js, line 55

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
`time`	Tone.Time

Inherited From:

Tone#toFrequency

Source:

core/Transport.js, line 802

Returns:

the time in hertz

Type: number

toMaster()

connect 'this' to the master output

Inherited From:

Tone#toMaster

Source:

core/Master.js, line 66

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
`time`	Tone.time

Inherited From:

Tone#toSamples

Source:

core/Tone.js, line 299

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

Parameters:

Name	Type	Argument	Description
`time`	Tone.Time
`now`	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

Tone#toSeconds

Source:

core/Tone.js, line 317

Returns:

Type: number

toSeconds(time, now) → {number}

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
`now`	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

Tone#toSeconds

Source:

core/Transport.js, line 823

Returns:

Type: number

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

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

Parameters:

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

Inherited From:

Tone#toTransportTime

Source:

core/Transport.js, line 783

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
`transportTime`	string
`bpm`	number	<optional>
`timeSignature`	number	<optional>

Inherited From:

Tone#transportTimeToSeconds

Source:

core/Transport.js, line 753

Returns:

seconds

Type: number

unsync()

unsync the LFO from transport control

Source:

component/LFO.js, line 62