EZ Web Audio

Appearance

EZ Web Audio / createCompressor

Function: createCompressor() ​

Call Signature ​

createCompressor(options?): CompressorEffect

Defined in: packages/core/src/effects/compressor-effect.ts:236

Factory function to create a CompressorEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext.

Parameters ​

options? ​

CompressorOptions

Optional compressor parameters

Returns ​

CompressorEffect

A new CompressorEffect instance

Example ​

typescript
// Zero-config (good defaults)
const comp = createCompressor()

// With options
const comp2 = createCompressor({ threshold: -30, ratio: 8, attack: 0.001 })

// With explicit AudioContext
const comp3 = createCompressor(audioContext, { threshold: -20 })

Call Signature ​

createCompressor(audioContext, options?): CompressorEffect

Defined in: packages/core/src/effects/compressor-effect.ts:237

Factory function to create a CompressorEffect.

AudioContext is optional. If omitted, uses the shared library AudioContext.

Parameters ​

audioContext ​

BaseAudioContext

options? ​

CompressorOptions

Optional compressor parameters

Returns ​

CompressorEffect

A new CompressorEffect instance

Example ​

typescript
// Zero-config (good defaults)
const comp = createCompressor()

// With options
const comp2 = createCompressor({ threshold: -30, ratio: 8, attack: 0.001 })

// With explicit AudioContext
const comp3 = createCompressor(audioContext, { threshold: -20 })