class_audioeffectspectrumanalyzer.rst 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzer.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectSpectrumAnalyzer:
  6. AudioEffectSpectrumAnalyzer
  7. ===========================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +------------------------------------------------------------+--------------------------------------------------------------------------------+------+
  15. | :ref:`float<class_float>` | :ref:`buffer_length<class_AudioEffectSpectrumAnalyzer_property_buffer_length>` | 2.0 |
  16. +------------------------------------------------------------+--------------------------------------------------------------------------------+------+
  17. | :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` | :ref:`fft_size<class_AudioEffectSpectrumAnalyzer_property_fft_size>` | 2 |
  18. +------------------------------------------------------------+--------------------------------------------------------------------------------+------+
  19. | :ref:`float<class_float>` | :ref:`tap_back_pos<class_AudioEffectSpectrumAnalyzer_property_tap_back_pos>` | 0.01 |
  20. +------------------------------------------------------------+--------------------------------------------------------------------------------+------+
  21. Enumerations
  22. ------------
  23. .. _enum_AudioEffectSpectrumAnalyzer_FFT_Size:
  24. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_256:
  25. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_512:
  26. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_1024:
  27. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_2048:
  28. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_4096:
  29. .. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_MAX:
  30. enum **FFT_Size**:
  31. - **FFT_SIZE_256** = **0**
  32. - **FFT_SIZE_512** = **1**
  33. - **FFT_SIZE_1024** = **2**
  34. - **FFT_SIZE_2048** = **3**
  35. - **FFT_SIZE_4096** = **4**
  36. - **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` enum.
  37. Property Descriptions
  38. ---------------------
  39. .. _class_AudioEffectSpectrumAnalyzer_property_buffer_length:
  40. - :ref:`float<class_float>` **buffer_length**
  41. +-----------+--------------------------+
  42. | *Default* | 2.0 |
  43. +-----------+--------------------------+
  44. | *Setter* | set_buffer_length(value) |
  45. +-----------+--------------------------+
  46. | *Getter* | get_buffer_length() |
  47. +-----------+--------------------------+
  48. ----
  49. .. _class_AudioEffectSpectrumAnalyzer_property_fft_size:
  50. - :ref:`FFT_Size<enum_AudioEffectSpectrumAnalyzer_FFT_Size>` **fft_size**
  51. +-----------+---------------------+
  52. | *Default* | 2 |
  53. +-----------+---------------------+
  54. | *Setter* | set_fft_size(value) |
  55. +-----------+---------------------+
  56. | *Getter* | get_fft_size() |
  57. +-----------+---------------------+
  58. ----
  59. .. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos:
  60. - :ref:`float<class_float>` **tap_back_pos**
  61. +-----------+-------------------------+
  62. | *Default* | 0.01 |
  63. +-----------+-------------------------+
  64. | *Setter* | set_tap_back_pos(value) |
  65. +-----------+-------------------------+
  66. | *Getter* | get_tap_back_pos() |
  67. +-----------+-------------------------+