7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
38 lines
1.5 KiB
XML
38 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectEQ" inherits="AudioEffect" version="4.0">
|
|
<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>
|
|
</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" />
|
|
<argument 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" />
|
|
<argument index="0" name="band_idx" type="int" />
|
|
<argument index="1" name="volume_db" type="float" />
|
|
<description>
|
|
Sets band's gain at the specified index, in dB.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|