EZ Web Audio

Appearance

EZ Web Audio / FilterEffect

Class: FilterEffect ​

Defined in: effects/filter-effect.ts:46

FilterEffect - A wrapper around BiquadFilterNode that implements the Effect interface.

Supports all 8 BiquadFilter types with wet/dry mixing via equal-power crossfade. The bypass and mix controls allow smooth blending between filtered and dry signal.

Example ​

typescript
const filter = createFilterEffect(audioContext, 'lowpass', { frequency: 800, q: 2 })
filter.frequency = 1000  // Adjust cutoff
filter.mix = 0.5  // 50% wet/dry
filter.bypass = true  // Bypass filter entirely

Implements ​

Constructors ​

Constructor ​

new FilterEffect(audioContext, type, options): FilterEffect

Defined in: effects/filter-effect.ts:56

Parameters ​

audioContext ​

AudioContext

type ​

FilterType

options ​

FilterEffectOptions = {}

Returns ​

FilterEffect

Accessors ​

bypass ​

Get Signature ​

get bypass(): boolean

Defined in: effects/filter-effect.ts:102

When true, signal bypasses the filter entirely (100% dry).

Returns ​

boolean

Set Signature ​

set bypass(v): void

Defined in: effects/filter-effect.ts:106

When true, effect is bypassed (passthrough)

Parameters ​
v ​

boolean

Returns ​

void

When true, effect is bypassed (passthrough)

Implementation of ​

Effect.bypass

detune ​

Get Signature ​

get detune(): number

Defined in: effects/filter-effect.ts:152

Filter detune in cents

Returns ​

number

Set Signature ​

set detune(v): void

Defined in: effects/filter-effect.ts:156

Parameters ​
v ​

number

Returns ​

void

frequency ​

Get Signature ​

get frequency(): number

Defined in: effects/filter-effect.ts:125

Filter frequency in Hz

Returns ​

number

Set Signature ​

set frequency(v): void

Defined in: effects/filter-effect.ts:129

Parameters ​
v ​

number

Returns ​

void

gain ​

Get Signature ​

get gain(): number

Defined in: effects/filter-effect.ts:143

Filter gain in dB (for shelf and peaking filters)

Returns ​

number

Set Signature ​

set gain(v): void

Defined in: effects/filter-effect.ts:147

Parameters ​
v ​

number

Returns ​

void

input ​

Get Signature ​

get input(): AudioNode

Defined in: effects/filter-effect.ts:90

The input AudioNode (receives signal from chain)

Returns ​

AudioNode

The input AudioNode that receives signal from the chain

Implementation of ​

Effect.input

mix ​

Get Signature ​

get mix(): number

Defined in: effects/filter-effect.ts:115

Wet/dry mix: 0 = fully dry (no filter), 1 = fully wet (all through filter). Uses equal-power crossfade for natural mixing.

Returns ​

number

Set Signature ​

set mix(v): void

Defined in: effects/filter-effect.ts:119

Wet/dry mix: 0 = fully dry (no effect), 1 = fully wet (full effect)

Parameters ​
v ​

number

Returns ​

void

Wet/dry mix: 0 = fully dry (no effect), 1 = fully wet (full effect)

Implementation of ​

Effect.mix

output ​

Get Signature ​

get output(): AudioNode

Defined in: effects/filter-effect.ts:95

The output AudioNode (sends signal to next in chain)

Returns ​

AudioNode

The output AudioNode that sends signal to the next in chain

Implementation of ​

Effect.output

q ​

Get Signature ​

get q(): number

Defined in: effects/filter-effect.ts:134

Filter Q factor (resonance)

Returns ​

number

Set Signature ​

set q(v): void

Defined in: effects/filter-effect.ts:138

Parameters ​
v ​

number

Returns ​

void

type ​

Get Signature ​

get type(): FilterType

Defined in: effects/filter-effect.ts:161

The current filter type

Returns ​

FilterType

Set Signature ​

set type(v): void

Defined in: effects/filter-effect.ts:165

Parameters ​
v ​

FilterType

Returns ​

void