mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
60 lines
3.1 KiB
ReStructuredText
60 lines
3.1 KiB
ReStructuredText
.. 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/<name>/doc_classes.
|
|
|
|
.. _class_AudioEffectEQ:
|
|
|
|
AudioEffectEQ
|
|
=============
|
|
|
|
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`AudioEffectEQ10<class_AudioEffectEQ10>`, :ref:`AudioEffectEQ21<class_AudioEffectEQ21>`, :ref:`AudioEffectEQ6<class_AudioEffectEQ6>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Base class for audio equalizers. Gives you control over frequencies.
|
|
|
|
Use it to create a custom equalizer if :ref:`AudioEffectEQ6<class_AudioEffectEQ6>`, :ref:`AudioEffectEQ10<class_AudioEffectEQ10>` or :ref:`AudioEffectEQ21<class_AudioEffectEQ21>` don't fit your needs.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_get_band_count>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_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<class_int>` **get_band_count** **(** **)** const
|
|
|
|
Returns the number of bands of the equalizer.
|
|
|
|
.. _class_AudioEffectEQ_get_band_gain_db:
|
|
|
|
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_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<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**
|
|
|
|
Sets band's gain at the specified index, in dB.
|
|
|