Table of Contents

Class AudioEffectSpectrumAnalyzerInstance

Namespace
Godot
Assembly
GodotSharp.dll

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 GetBusEffectInstance(int, int, int).

public class AudioEffectSpectrumAnalyzerInstance : AudioEffectInstance, IDisposable
Inheritance
AudioEffectSpectrumAnalyzerInstance
Implements
Inherited Members

Methods

GetMagnitudeForFrequencyRange(float, float, MagnitudeMode)

Returns the magnitude of the frequencies from fromHz to toHz 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 AudioEffectSpectrumAnalyzerInstance.MagnitudeMode.

public Vector2 GetMagnitudeForFrequencyRange(float fromHz, float toHz, AudioEffectSpectrumAnalyzerInstance.MagnitudeMode mode = MagnitudeMode.Max)

Parameters

fromHz float
toHz float
mode AudioEffectSpectrumAnalyzerInstance.MagnitudeMode

Returns

Vector2

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page