AudioEffects. AudioFilter

Filter effect, muffle sounds underwater or behind a wall

Constructor

new AudioFilter(typeopt, frequencyopt, qopt, mixopt)

Create a filter effect

Parameters:
NameTypeAttributesDefaultDescription
typeBiquadFilterType<optional>
lowpass

lowpass, highpass, bandpass, notch, etc.

frequencynumber<optional>
1000

Cutoff or center frequency in Hz

qnumber<optional>
1

Resonance at the cutoff, higher is sharper

mixnumber<optional>
1

Wet/dry balance, 0 is fully dry and 1 is fully wet

Example
const muffle = new AudioFilter('lowpass', 400);
setAudioMasterEffect(muffle);
muffle.setFrequency(20000, .5); // sweep back to clear

Extends

  • AudioEffect

Members

node

Properties
TypeDescription
BiquadFilterNode

The filter node

Methods

setFrequency(frequency, fadeTimeopt)

Set the cutoff or center frequency

Parameters:
NameTypeAttributesDefaultDescription
frequencynumber

Frequency in Hz

fadeTimenumber<optional>
0

Seconds to sweep over

setQ(q, fadeTimeopt)

Set the resonance at the cutoff

Parameters:
NameTypeAttributesDefaultDescription
qnumber

Higher is sharper

fadeTimenumber<optional>
0

Seconds to ramp over