36 lines
1.6 KiB
XML
36 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectEQ" inherits="AudioEffect" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
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>
|
|
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).
|
|
</description>
|
|
<tutorials>
|
|
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_band_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of bands of the equalizer.
|
|
</description>
|
|
</method>
|
|
<method name="get_band_gain_db" qualifiers="const">
|
|
<return type="float" />
|
|
<param index="0" name="band_idx" type="int" />
|
|
<description>
|
|
Returns the band's gain at the specified index, in dB.
|
|
</description>
|
|
</method>
|
|
<method name="set_band_gain_db">
|
|
<return type="void" />
|
|
<param index="0" name="band_idx" type="int" />
|
|
<param index="1" name="volume_db" type="float" />
|
|
<description>
|
|
Sets band's gain at the specified index, in dB.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|