Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 1.8 KB

class_audioeffectfilter.rst

File metadata and controls

58 lines (33 loc) · 1.8 KB
Raw

AudioEffectFilter

Inherits: AudioEffect<class_audioeffect> < Resource<class_resource> < Reference<class_reference> < Object<class_object>

Inherited By: AudioEffectHighPassFilter<class_audioeffecthighpassfilter>, AudioEffectBandLimitFilter<class_audioeffectbandlimitfilter>, AudioEffectLowShelfFilter<class_audioeffectlowshelffilter>, AudioEffectHighShelfFilter<class_audioeffecthighshelffilter>, AudioEffectBandPassFilter<class_audioeffectbandpassfilter>, AudioEffectNotchFilter<class_audioeffectnotchfilter>, AudioEffectLowPassFilter<class_audioeffectlowpassfilter>

Category: Core

Brief Description

Adds a filter to the Audio Bus.

Member Variables

  • float<class_float> cutoff_hz - Threshold frequency for the filter.
  • FilterDB<enum_audioeffectfilter_filterdb> db
  • float<class_float> gain - Gain amount of the frequencies after the filter.
  • float<class_float> resonance - Amount of boost in the overtones near the cutoff frequency.

Enums

enum FilterDB

  • FILTER_6DB = 0
  • FILTER_12DB = 1
  • FILTER_18DB = 2
  • FILTER_24DB = 3

Description

Allows frequencies other than the cutoff_hz<class_AudioEffectFilter_cutoff_hz> to pass.