summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectEQ.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioEffectEQ.xml')
-rw-r--r--doc/classes/AudioEffectEQ.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml
index 908ae956ed..6e4040c16e 100644
--- a/doc/classes/AudioEffectEQ.xml
+++ b/doc/classes/AudioEffectEQ.xml
@@ -8,6 +8,7 @@
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">
@@ -18,15 +19,15 @@
</method>
<method name="get_band_gain_db" qualifiers="const">
<return type="float" />
- <argument index="0" name="band_idx" type="int" />
+ <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" />
- <argument index="0" name="band_idx" type="int" />
- <argument index="1" name="volume_db" type="float" />
+ <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>