virtualx-engine/doc/classes/AudioEffectEQ.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ" inherits="AudioEffect" version="3.4">
	<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">
			</return>
			<description>
				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>
				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>
				Sets band's gain at the specified index, in dB.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>