Skip to content

EZ Web Audio / CompressorOptions

Interface: CompressorOptions ​

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

Options for creating a CompressorEffect.

Properties ​

attack? ​

optional attack: number

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

Attack time in seconds (default: 0.003). How fast compression engages


knee? ​

optional knee: number

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

Knee width in dB (default: 30). Wider knee = gentler transition


mix? ​

optional mix: number

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

Wet/dry mix 0-1 (default: 1)


ratio? ​

optional ratio: number

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

Compression ratio (default: 4). e.g., 4:1 means 4dB above threshold → 1dB output


release? ​

optional release: number

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

Release time in seconds (default: 0.25). How fast compression releases


threshold? ​

optional threshold: number

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

Threshold in dB above which compression starts (default: -24)