Skip to main content

AudioCompressorFilter

Electron APIs / recorder / AudioCompressorFilter

A specialized filter for dynamic range compression.

Example

const vocalComp: AudioCompressorFilter = {
id: "compressor_filter",
parameters: {
ratio: 4,
threshold: -20,
},
};

Extends

Properties

PropertyTypeDescriptionOverrides
id"compressor_filter"A unique identifier for the filter instance.AudioFilterBase.id
parameters?objectConfiguration settings specific to the compressor.AudioFilterBase.parameters
parameters.attack_time?numberHow quickly (in ms) the compressor reduces the volume. Valid range: [1, 500]-
parameters.output_gain?numberThe gain (in dB) applied to the signal after compression to compensate for volume loss. Valid range: [-32.00, 32.00]-
parameters.ratio?numberThe amount of gain reduction applied once the signal exceeds the threshold. Valid range: [1.00, 32.00]-
parameters.release_time?numberHow quickly (in ms) the compressor returns to normal volume after the signal drops. Valid range: [1, 1000]-
parameters.threshold?numberThe level (in dB) above which compression begins. Valid range: [-60.0, 0.00]-