Base class for filters. Use effects that inherit this class instead of using it directly.
A "filter" controls the gain of frequencies, using cutoff_hz 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
Gain of the frequencies affected by the filter. This property is only available for AudioEffectLowShelfFilter and AudioEffectHighShelfFilter. Value can range from 0 to 4.
Gain at or directly next to the cutoff_hz 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 cutoff_hz frequency and decreasing frequencies on the opposite side.
- For the band-pass and notch filters, it widens or narrows the filter at the cutoff_hz frequency threshold.
- For low/high-pass filters, it increases or decreases frequencies at the cutoff_hz frequency threshold.
FILTER_6DB = 0Cutting off at 6 dB per octave. One octave is twice the frequency above cutoff_hz, or half the frequency below cutoff_hz.
FILTER_12DB = 1Cutting off at 12 dB per octave. One octave is twice the frequency above cutoff_hz, or half the frequency below cutoff_hz.