Documentation
¶
Overview ¶
Package AudioEffectSpectrumAnalyzerInstance provides methods for working with AudioEffectSpectrumAnalyzerInstance object instances.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type 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) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type MagnitudeMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Expanded ¶
type Expanded [1]gdclass.AudioEffectSpectrumAnalyzerInstance
func (Expanded) GetMagnitudeForFrequencyRange ¶
func (self Expanded) GetMagnitudeForFrequencyRange(from_hz Float.X, to_hz Float.X, mode MagnitudeMode) 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].
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsAudioEffectInstance ¶
func (self *Extension[T]) AsAudioEffectInstance() AudioEffectInstance.Instance
func (*Extension[T]) AsAudioEffectSpectrumAnalyzerInstance ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
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 obtained 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 (Instance) AsAudioEffectInstance ¶
func (self Instance) AsAudioEffectInstance() AudioEffectInstance.Instance
func (Instance) AsAudioEffectSpectrumAnalyzerInstance ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) GetMagnitudeForFrequencyRange ¶
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].
type MagnitudeMode ¶
type MagnitudeMode int //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 )
Source Files