.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the AudioEffectEQ.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectEQ: AudioEffectEQ ============= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` **Category:** Core Brief Description ----------------- Base class for audio equalizers. Gives you control over frequencies. Use it to create a custom equalizer if :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10` or :ref:`AudioEffectEQ21` don't fit your needs. Methods ------- +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_band_count` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_band_gain_db` **(** :ref:`int` band_idx **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_band_gain_db` **(** :ref:`int` band_idx, :ref:`float` volume_db **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very 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). Method Descriptions ------------------- .. _class_AudioEffectEQ_get_band_count: - :ref:`int` **get_band_count** **(** **)** const Returns the number of bands of the equalizer. .. _class_AudioEffectEQ_get_band_gain_db: - :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const Returns the band's gain at the specified index, in dB. .. _class_AudioEffectEQ_set_band_gain_db: - void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** Sets band's gain at the specified index, in dB.