Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Inherits: AudioEffect < Resource < RefCounted < Object
Inherited By: AudioEffectEQ10, AudioEffectEQ21, AudioEffectEQ6
Base class for audio equalizers. Gives you control over frequencies.
Use it to create a custom equalizer if AudioEffectEQ6, AudioEffectEQ10 or AudioEffectEQ21 don't fit your needs.
AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQs are useful on the Master bus to completely master a mix and give it more character. They are also useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged).
get_band_count ( ) const
get_band_gain_db ( int band_idx ) const
set_band_gain_db ( int band_idx, float volume_db )
int get_band_count ( ) const
Returns the number of bands of the equalizer.
float get_band_gain_db ( int band_idx ) const
Returns the band's gain at the specified index, in dB.
void set_band_gain_db ( int band_idx, float volume_db )
Sets band's gain at the specified index, in dB.