summaryrefslogtreecommitdiff
path: root/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
blob: 55ac78f19711a1179bae0397e77188fe1330ae8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_magnitude_for_frequency_range" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="from_hz" type="float" />
			<param index="1" name="to_hz" type="float" />
			<param index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1" />
			<description>
			</description>
		</method>
	</methods>
	<constants>
		<constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
			Use the average value as magnitude.
		</constant>
		<constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
			Use the maximum value as magnitude.
		</constant>
	</constants>
</class>