:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectSpectrumAnalyzer.xml. .. _class_AudioEffectSpectrumAnalyzer: AudioEffectSpectrumAnalyzer =========================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Audio effect that can be used for real-time audio visualizations. .. rst-class:: classref-introduction-group Description ----------- This audio effect does not affect sound output, but can be used for real-time audio visualizations. This resource configures an :ref:`AudioEffectSpectrumAnalyzerInstance`, which performs the actual analysis at runtime. An instance can be obtained with :ref:`AudioServer.get_bus_effect_instance()`. See also :ref:`AudioStreamGenerator` for procedurally generating sounds. .. rst-class:: classref-introduction-group Tutorials --------- - `Audio Spectrum Visualizer Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`buffer_length` | ``2.0`` | +----------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`FFTSize` | :ref:`fft_size` | ``2`` | +----------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`tap_back_pos` | ``0.01`` | +----------------------------------------------------------+--------------------------------------------------------------------------------+----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioEffectSpectrumAnalyzer_FFTSize: .. rst-class:: classref-enumeration enum **FFTSize**: :ref:`🔗` .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_256: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_256** = ``0`` Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_512: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_512** = ``1`` Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_1024: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_1024** = ``2`` Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_2048: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_2048** = ``3`` Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_4096: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_4096** = ``4`` Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_MAX: .. rst-class:: classref-enumeration-constant :ref:`FFTSize` **FFT_SIZE_MAX** = ``5`` Represents the size of the :ref:`FFTSize` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioEffectSpectrumAnalyzer_property_buffer_length: .. rst-class:: classref-property :ref:`float` **buffer_length** = ``2.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_buffer_length**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_buffer_length**\ (\ ) The length of the buffer to keep (in seconds). Higher values keep data around for longer, but require more memory. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectSpectrumAnalyzer_property_fft_size: .. rst-class:: classref-property :ref:`FFTSize` **fft_size** = ``2`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_fft_size**\ (\ value\: :ref:`FFTSize`\ ) - :ref:`FFTSize` **get_fft_size**\ (\ ) The size of the `Fast Fourier transform `__ buffer. Higher values smooth out the spectrum analysis over time, but have greater latency. The effects of this higher latency are especially noticeable with sudden amplitude changes. .. rst-class:: classref-item-separator ---- .. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos: .. rst-class:: classref-property :ref:`float` **tap_back_pos** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tap_back_pos**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_tap_back_pos**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`