virtualx-engine/doc/classes/AudioEffectEQ.xml

44 lines
1.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 12:33:56 +02:00
<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.2">
<brief_description>
2017-09-16 18:47:19 +02:00
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.
</brief_description>
<description>
2017-09-16 18:47:19 +02:00
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).
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_band_count" qualifiers="const">
<return type="int">
</return>
<description>
2017-09-16 18:47:19 +02:00
Returns the number of bands of the equalizer.
</description>
</method>
<method name="get_band_gain_db" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="band_idx" type="int">
</argument>
<description>
2017-09-16 18:47:19 +02:00
Returns the band's gain at the specified index, in dB.
</description>
</method>
<method name="set_band_gain_db">
<return type="void">
</return>
<argument index="0" name="band_idx" type="int">
</argument>
<argument index="1" name="volume_db" type="float">
</argument>
<description>
2017-09-16 18:47:19 +02:00
Sets band's gain at the specified index, in dB.
</description>
</method>
</methods>
<constants>
</constants>
</class>