AudioEffectSpectrumAnalyzerInstance

Documentation

Overview

Package AudioEffectSpectrumAnalyzerInstance provides methods for working with AudioEffectSpectrumAnalyzerInstance object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioEffectInstance() AudioEffectInstance.Instance
  • func (self Instance) AsAudioEffectSpectrumAnalyzerInstance() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) GetMagnitudeForFrequencyRange(from_hz Float.X, to_hz Float.X) Vector2.XY
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type MagnitudeMode

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsAudioEffectSpectrumAnalyzerInstance() Instance
}

type Instance

type Instance [1]gdclass.AudioEffectSpectrumAnalyzerInstance

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].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsAudioEffectInstance

func (self Instance) AsAudioEffectInstance() AudioEffectInstance.Instance

func (Instance) AsAudioEffectSpectrumAnalyzerInstance

func (self Instance) AsAudioEffectSpectrumAnalyzerInstance() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) GetMagnitudeForFrequencyRange

func (self Instance) GetMagnitudeForFrequencyRange(from_hz Float.X, to_hz Float.X) Vector2.XY

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].

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type MagnitudeMode

type MagnitudeMode = gdclass.AudioEffectSpectrumAnalyzerInstanceMagnitudeMode //gd:AudioEffectSpectrumAnalyzerInstance.MagnitudeMode

const (
	/*Use the average value across the frequency range as magnitude.*/
	MagnitudeAverage MagnitudeMode = 0
	/*Use the maximum value of the frequency range as magnitude.*/
	MagnitudeMax MagnitudeMode = 1
)