lfo

lfo
===

Low frequency oscillator for automating Web Audio API AudioParams.

Install

``bash
$ npm install lfo
`

API

`js
var LFO = require('lfo')
`

$3

Returns an LFO AudioNode instance.

$3

Modulate this base value based on operation specified by node.mode.

$3

Oscillation rate in cycles per second (Hz).

$3

Amplitude of the oscillation.

$3

The operation to apply to node.value. Defaults to 'multiply'.

$3

The waveform shape: 'sine', 'triangle', 'sawtooth', 'sawtooth_i' or 'square'

$3

$3

When true, the oscillation rate is multiplied by node.tempo / 60 to allow beat sync.

$3

Set the tempo (BPM) for use when node.sync is true.

$3

Connect the modulator to the desired destination audio param.

$3

Disconnect from any target AudioParams.

$3

Starts the LFO at specified time. This method can only be called once. Create new instances of LFO for each scheduled events.

$3

Stops the LFO at specified time.

Example

Create tremolo effect

``js

var LFO = require('lfo')

var audioContext = new AudioContext()
var oscillator = audioContext.createOscillator()
var gain = audioContext.createGain()

oscillator.connect(gain)
gain.connect(audioContext.destination)

var lfoModulator = LFO(audioContext)
gain.value = 2 // set oscillation centre value

lfoModulator.rate = 4 // hz
lfoModulator.shape = 'sine'
lfoModulator.connect(gain.gain)

lfoModulator.start(audioContext.currentTime)
oscillator.start(audioContext.currentTime)

lfoModulator.stop(audioContext.currentTime + 1)
oscillator.stop(audioContext.currentTime + 1)
``