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 | Description |
|---|---|---|---|
rate |
number | ||
outputMin |
number |
<optional> |
|
outputMax |
number |
<optional> |
Extends
Members
-
<private> _connect
-
pointer to the parent's connect method
-
bufferSize :number
-
the default buffer size
Type:
- number
- Inherited From:
- Source:
-
context :AudioContext
-
A static pointer to the audio context
Type:
- AudioContext
- Inherited From:
- Source:
-
input :GainNode
-
default input of the ToneNode
Type:
- GainNode
- Inherited From:
- Source:
-
isFrequency
-
true if the input is in the format number+hz i.e.: 10hz
- Inherited From:
- Source:
-
isNotation
-
tests if a string is musical notation i.e.: 4n = quarter note 2m = two measures 8t = eighth-note triplet
- Inherited From:
- Source:
-
isTransportTime
-
tests if a string is transportTime i.e. : 1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes
- Inherited From:
- Source:
-
oscillator :Tone.Oscillator
-
Type:
-
output :GainNode
-
default output of the ToneNode
Type:
- GainNode
- Inherited From:
- Source:
-
scaler :Tone.Scale
-
Type:
-
waveShaperResolution :number
-
the default resolution for WaveShaperNodes
Type:
- number
- Inherited From:
- Source:
Methods
-
chain()
-
connect together all of the arguments in series
Parameters:
Type Argument Description AudioParam | Tone <repeatable>
- Inherited From:
- Source:
-
connect(param)
-
override the connect method so that it 0's out the value if attached to an AudioParam
Parameters:
Name Type Description paramAudioNode | AudioParam | Tone -
dbToGain(db) → {number}
-
convert db scale to gain scale (0-1)
Parameters:
Name Type Description dbnumber - Inherited From:
- Source:
Returns:
- Type
- number
-
defaultArg(given, fallback) → {*}
-
if a the given is undefined, use the fallback
Parameters:
Name Type Description given* fallback* - Inherited From:
- Source:
Returns:
- Type
- *
-
disconnect()
-
disconnect the output
- Inherited From:
- Source:
-
dispose()
-
disconnect and dispose
-
equalPowerScale(percent) → {number}
-
equal power gain scale good for cross-fading
Parameters:
Name Type Description percentnumber (0-1) - Inherited From:
- Source:
Returns:
output gain (0-1)- Type
- number
-
expScale(gain) → {number}
-
Parameters:
Name Type Description gainnumber (0-1) - Inherited From:
- Source:
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 freqnumber | string - Inherited From:
- Source:
Returns:
- Type
- number
-
gainToDb(gain) → {number}
-
convert gain scale to decibels
Parameters:
Name Type Description gainnumber (0-1) - Inherited From:
- Source:
Returns:
- Type
- number
-
interpolate(input, outputMin, outputMax) → {number}
-
interpolate the input value (0-1) to be between outputMin and outputMax
Parameters:
Name Type Description inputnumber outputMinnumber outputMaxnumber - Inherited From:
- Source:
Returns:
- Type
- number
-
logScale(gain) → {number}
-
Parameters:
Name Type Description gainnumber (0-1) - Inherited From:
- Source:
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
-
normalize(input, inputMin, inputMax) → {number}
-
normalize the input to 0-1 from between inputMin to inputMax
Parameters:
Name Type Description inputnumber inputMinnumber inputMaxnumber - Inherited From:
- Source:
Returns:
- Type
- number
-
notationToSeconds(notation, bpm, timeSignature) → {number}
-
convert notation format strings to seconds
Parameters:
Name Type Argument Description notationstring bpmnumber <optional>
timeSignaturenumber <optional>
- Inherited From:
- Source:
Returns:
- Type
- number
-
now() → {number}
-
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 channelNamestring - Inherited From:
- Source:
-
samplesToSeconds(samples) → {number}
-
convert a sample count to seconds
Parameters:
Name Type Description samplesnumber - Inherited From:
- Source:
Returns:
- Type
- number
-
secondsToFrequency(seconds) → {number}
-
convert a number in seconds to a frequency
Parameters:
Name Type Description secondsnumber - Inherited From:
- Source:
Returns:
- Type
- number
-
send(channelName, amount) → {GainNode}
-
send signal to a channel name
Parameters:
Name Type Description channelNamestring amountnumber Returns:
- Type
- GainNode
-
setFrequency(rate)
-
set the frequency
Parameters:
Name Type Description ratenumber -
setMax(min)
-
set the maximum output of the LFO
Parameters:
Name Type Description minnumber -
setMin(min)
-
set the minimum output of the LFO
Parameters:
Name Type Description minnumber -
setType(type)
-
set the waveform of the LFO
Parameters:
Name Type Description typestring -
start(time)
-
start the LFO
Parameters:
Name Type Description timeTone.Time -
stop(time)
-
stop the LFO
Parameters:
Name Type Description timeTone.Time -
sync()
-
Sync the start/stop/pause to the transport and the frequency to the bpm of the transport
-
toFrequency(time) → {number}
-
convert a time to a frequency
Parameters:
Name Type Description timeTone.Time - Inherited From:
- Source:
Returns:
the time in hertz- Type
- number
-
toMaster()
-
connect 'this' to the master output
- Inherited From:
- Source:
-
toSamples(time) → {number}
-
convert a time into samples
Parameters:
Name Type Description timeTone.time - Inherited From:
- Source:
Returns:
- Type
- number
-
toSeconds(time) → {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 Description timeTone.Time - Inherited From:
- Source:
Returns:
- Type
- number
-
toSeconds(time, bpm, timeSignature) → {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 timeTone.Time bpmnumber <optional>
timeSignaturenumber <optional>
- Inherited From:
- Source:
Returns:
- Type
- number
-
toTransportTime(seconds, bpm, timeSignature) → {string}
-
Convert seconds to the closest transportTime in the form measures:quarters:sixteenths
Parameters:
Name Type Argument Description secondsTone.Time bpmnumber <optional>
timeSignaturenumber <optional>
- Inherited From:
- Source:
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 transportTimestring bpmnumber <optional>
timeSignaturenumber <optional>
- Inherited From:
- Source:
Returns:
seconds- Type
- number
-
unsync()
-
unsync the LFO from transport control