EZ Web Audio

Appearance

EZ Web Audio / createFilterEffect

Function: createFilterEffect() ​

Call Signature ​

createFilterEffect(type, options?): FilterEffect

Defined in: packages/core/src/effects/filter-effect.ts:240

Factory function to create a FilterEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext (created lazily on first use).

Parameters ​

type ​

FilterType

The BiquadFilterType string (or AudioContext as first arg for backwards compatibility)

options? ​

FilterEffectOptions

Optional filter parameters

Returns ​

FilterEffect

A new FilterEffect instance

Example ​

typescript
// Without AudioContext (recommended)
const lowpass = createFilterEffect('lowpass', { frequency: 800 })

// With explicit AudioContext (backwards compatible)
const highpass = createFilterEffect(audioContext, 'highpass', { frequency: 200, q: 2 })

Call Signature ​

createFilterEffect(audioContext, type, options?): FilterEffect

Defined in: packages/core/src/effects/filter-effect.ts:244

Factory function to create a FilterEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext (created lazily on first use).

Parameters ​

audioContext ​

BaseAudioContext

type ​

FilterType

The BiquadFilterType string (or AudioContext as first arg for backwards compatibility)

options? ​

FilterEffectOptions

Optional filter parameters

Returns ​

FilterEffect

A new FilterEffect instance

Example ​

typescript
// Without AudioContext (recommended)
const lowpass = createFilterEffect('lowpass', { frequency: 800 })

// With explicit AudioContext (backwards compatible)
const highpass = createFilterEffect(audioContext, 'highpass', { frequency: 200, q: 2 })