AudioFilter

Electron APIs / recorder / AudioFilter

type AudioFilter =
  | AudioCompressorFilter
  | AudioExpanderFilter
  | AudioGainFilter
  | AudioInvertPolarityFilter
  | AudioLimiterFilter
  | AudioNoiseGateFilter
  | AudioNoiseSuppressFilterV2;

A union type representing all available audio filters.

This type uses the id property as a type discriminator. When used in a switch statement or conditional, TypeScript will narrow the parameters to the specific interface associated with that ID.

For more information about the filter types, see OBS Audio Filters.

Example

function applyFilter(filter: AudioFilter) {
  if (filter.id === "gain_filter") {
    // TypeScript knows filter.parameters.db exists here
    console.log(filter.parameters?.db);
  }
}