mirror of
https://github.com/godotengine/godot.git
synced 2024-10-23 05:31:54 +00:00
b6c0d07dc8
Fully document AudioEffectSpectrumAnalyzerInstance, including the weird return value of its sole method, and add a link to it in AudioEffectSpectrumAnalyzer to make it easier to figure out how to use.
34 lines
1.7 KiB
XML
34 lines
1.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectSpectrumAnalyzerInstance" inherits="AudioEffectInstance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Queryable instance of an [AudioEffectSpectrumAnalyzer].
|
|
</brief_description>
|
|
<description>
|
|
The runtime part of an [AudioEffectSpectrumAnalyzer], which can be used to query the magnitude of a frequency range on its host bus.
|
|
An instance of this class can be acquired with [method AudioServer.get_bus_effect_instance].
|
|
</description>
|
|
<tutorials>
|
|
<link title="Audio Spectrum Visualizer Demo">https://godotengine.org/asset-library/asset/2762</link>
|
|
</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>
|
|
Returns the magnitude of the frequencies from [param from_hz] to [param to_hz] in linear energy as a Vector2. The [code]x[/code] component of the return value represents the left stereo channel, and [code]y[/code] represents the right channel.
|
|
[param mode] determines how the frequency range will be processed. See [enum MagnitudeMode].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
<constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
|
|
Use the average value across the frequency range as magnitude.
|
|
</constant>
|
|
<constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
|
|
Use the maximum value of the frequency range as magnitude.
|
|
</constant>
|
|
</constants>
|
|
</class>
|