AudioEffectFilter — C# API

Base class for filters. Use effects that inherit this class instead of using it directly.

class AudioEffectFilterReckfellSharpInherits AudioEffect

Base class for filters. Use effects that inherit this class instead of using it directly.

A "filter" controls the gain of frequencies, using AudioEffectFilter.CutoffHz as a frequency threshold. Filters can help to give room for each sound, and create interesting effects. There are different types of filter that inherit this class: Shelf filters: AudioEffectLowShelfFilter and AudioEffectHighShelfFilter Band-pass and notch filters: AudioEffectBandPassFilter, AudioEffectBandLimitFilter, and AudioEffectNotchFilter Low/high-pass filters: AudioEffectLowPassFilter and AudioEffectHighPassFilter

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectFilterConstructor

# AudioEffectFilter

C#
public AudioEffectFilter();

Properties4

CutoffHzProperty

# CutoffHz

C#
public float CutoffHz { get; set; }

Frequency threshold for the filter, in Hz. Value can range from 1 to 20500.

DbProperty

# Db

C#
public AudioEffectFilter.FilterDB Db { get; set; }

Steepness of the cutoff curve in dB per octave (twice the frequency above AudioEffectFilter.CutoffHz, or half the frequency below AudioEffectFilter.CutoffHz), also known as the "order" of the filter. Higher orders have a more aggressive cutoff.

GainProperty

# Gain

C#
public float Gain { get; set; }

Gain of the frequencies affected by the filter. This property is only available for AudioEffectLowShelfFilter and AudioEffectHighShelfFilter. Value can range from 0 to 4.

ResonanceProperty

# Resonance

C#
public float Resonance { get; set; }

Gain at or directly next to the AudioEffectFilter.CutoffHz frequency threshold. Value can range from 0 to 1. Its exact behavior depends on the selected filter type:

For shelf filters, it accentuates or masks the order by increasing frequencies right next to the AudioEffectFilter.CutoffHz frequency and decreasing frequencies on the opposite side.
For the band-pass and notch filters, it widens or narrows the filter at the AudioEffectFilter.CutoffHz frequency threshold.
For low/high-pass filters, it increases or decreases frequencies at the AudioEffectFilter.CutoffHz frequency threshold.

Methods8

GetCutofffloat

# GetCutoff

C#
public float GetCutoff();

Returns float

GetDbAudioEffectFilter.FilterDB

# GetDb

C#
public AudioEffectFilter.FilterDB GetDb();

Returns AudioEffectFilter.FilterDB

GetGainfloat

# GetGain

C#
public float GetGain();

Returns float

GetResonancefloat

# GetResonance

C#
public float GetResonance();

Returns float

SetCutoffvoid

# SetCutoff

C#
public void SetCutoff(float freq);

Parameters
Name	Type	Default
`freq`	`float`	—

SetDbvoid

# SetDb

C#
public void SetDb(AudioEffectFilter.FilterDB amount);

Parameters
Name	Type	Default
`amount`	`AudioEffectFilter.FilterDB`	—

SetGainvoid

# SetGain

C#
public void SetGain(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetResonancevoid

# SetResonance

C#
public void SetResonance(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

AudioEffectFilter.FilterDB

Value	Description
`Filter12Db = 1`	Cutting off at 12 dB per octave. One octave is twice the frequency above `AudioEffectFilter.CutoffHz`, or half the frequency below `AudioEffectFilter.CutoffHz`.
`Filter18Db = 2`	Cutting off at 18 dB per octave. One octave is twice the frequency above `AudioEffectFilter.CutoffHz`, or half the frequency below `AudioEffectFilter.CutoffHz`.
`Filter24Db = 3`	Cutting off at 24 dB per octave. One octave is twice the frequency above `AudioEffectFilter.CutoffHz`, or half the frequency below `AudioEffectFilter.CutoffHz`.
`Filter6Db = 0`	Cutting off at 6 dB per octave. One octave is twice the frequency above `AudioEffectFilter.CutoffHz`, or half the frequency below `AudioEffectFilter.CutoffHz`.