<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectEQ" inherits="AudioEffect" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for audio equalizers (EQ). 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>
		An "equalizer" gives you control over the gain of frequencies in the entire spectrum, by allowing their adjustment through bands. A band is a point in the frequency spectrum, and each band means a division of the spectrum that can be adjusted.
		Use equalizers to compensate for existing deficiencies in the audio, make room for other elements, or remove undesirable frequencies. AudioEffectEQs are useful on the Master bus to balance the entire mix or 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 disabled when headphones are plugged in).
	</description>
	<tutorials>
		<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
		<link title="Audio effects">$DOCS_URL/tutorials/audio/audio_effects.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>
