godot-docs/classes/class_audioeffectspectrumanalyzer.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioEffectSpectrumAnalyzer:

AudioEffectSpectrumAnalyzer
===========================

**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------



Properties
----------

+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`float<class_float>`                                  | :ref:`buffer_length<class_AudioEffectSpectrumAnalyzer_property_buffer_length>` | 2.0  |
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` | :ref:`fft_size<class_AudioEffectSpectrumAnalyzer_property_fft_size>`           | 2    |
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+
| :ref:`float<class_float>`                                  | :ref:`tap_back_pos<class_AudioEffectSpectrumAnalyzer_property_tap_back_pos>`   | 0.01 |
+------------------------------------------------------------+--------------------------------------------------------------------------------+------+

Enumerations
------------

.. _enum_AudioEffectSpectrumAnalyzer_FFT_Size:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_256:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_512:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_1024:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_2048:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_4096:

.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_MAX:

enum **FFT_Size**:

- **FFT_SIZE_256** = **0**

- **FFT_SIZE_512** = **1**

- **FFT_SIZE_1024** = **2**

- **FFT_SIZE_2048** = **3**

- **FFT_SIZE_4096** = **4**

- **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` enum.

Property Descriptions
---------------------

.. _class_AudioEffectSpectrumAnalyzer_property_buffer_length:

- :ref:`float<class_float>` **buffer_length**

+-----------+--------------------------+
| *Default* | 2.0                      |
+-----------+--------------------------+
| *Setter*  | set_buffer_length(value) |
+-----------+--------------------------+
| *Getter*  | get_buffer_length()      |
+-----------+--------------------------+

.. _class_AudioEffectSpectrumAnalyzer_property_fft_size:

- :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size**

+-----------+---------------------+
| *Default* | 2                   |
+-----------+---------------------+
| *Setter*  | set_fft_size(value) |
+-----------+---------------------+
| *Getter*  | get_fft_size()      |
+-----------+---------------------+

.. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos:

- :ref:`float<class_float>` **tap_back_pos**

+-----------+-------------------------+
| *Default* | 0.01                    |
+-----------+-------------------------+
| *Setter*  | set_tap_back_pos(value) |
+-----------+-------------------------+
| *Getter*  | get_tap_back_pos()      |
+-----------+-------------------------+