Attention: Here be dragons (unstable version)
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
Checking the stable version of the documentation...
AudioEffectSpectrumAnalyzerInstance
Inherits: AudioEffectInstance < RefCounted < Object
Queryable instance of an AudioEffectSpectrumAnalyzer.
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 obtained with AudioServer.get_bus_effect_instance.
Tutorials
Methods
get_magnitude_for_frequency_range(from_hz: float, to_hz: float, mode: MagnitudeMode = 1) const |
Enumerations
enum MagnitudeMode: 🔗
MagnitudeMode MAGNITUDE_AVERAGE = 0
Use the average value across the frequency range as magnitude.
MagnitudeMode MAGNITUDE_MAX = 1
Use the maximum value of the frequency range as magnitude.
Method Descriptions
Vector2 get_magnitude_for_frequency_range(from_hz: float, to_hz: float, mode: MagnitudeMode = 1) const 🔗
Returns the magnitude of the frequencies from from_hz to to_hz in linear energy as a Vector2. The x component of the return value represents the left stereo channel, and y represents the right channel.
mode determines how the frequency range will be processed. See MagnitudeMode.