Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_audioeffectspectrumanalyzerinstance.rst

class_audioeffectspectrumanalyzerinstance.rst 2.6 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzerInstance.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_AudioEffectSpectrumAnalyzerInstance:
    8. 

  8. 

  9. AudioEffectSpectrumAnalyzerInstance
    10. 

  10. ===================================
    11. 

  11. 

  12. **Inherits:** :ref:`AudioEffectInstance<class_AudioEffectInstance>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. 

  15. 

  16. Methods
    17. 

  17. -------
    18. 

  18. 

  19. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    20. 

  20. | :ref:`Vector2<class_Vector2>` | :ref:`get_magnitude_for_frequency_range<class_AudioEffectSpectrumAnalyzerInstance_method_get_magnitude_for_frequency_range>` **(** :ref:`float<class_float>` from_hz, :ref:`float<class_float>` to_hz, :ref:`MagnitudeMode<enum_AudioEffectSpectrumAnalyzerInstance_MagnitudeMode>` mode=1 **)** |const| |
    21. 

  21. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. 

  23. Enumerations
    24. 

  24. ------------
    25. 

  25. 

  26. .. _enum_AudioEffectSpectrumAnalyzerInstance_MagnitudeMode:
    27. 

  27. 

  28. .. _class_AudioEffectSpectrumAnalyzerInstance_constant_MAGNITUDE_AVERAGE:
    29. 

  29. 

  30. .. _class_AudioEffectSpectrumAnalyzerInstance_constant_MAGNITUDE_MAX:
    31. 

  31. 

  32. enum **MagnitudeMode**:
    33. 

  33. 

  34. - **MAGNITUDE_AVERAGE** = **0** --- Use the average value as magnitude.
    35. 

  35. 

  36. - **MAGNITUDE_MAX** = **1** --- Use the maximum value as magnitude.
    37. 

  37. 

  38. Method Descriptions
    39. 

  39. -------------------
    40. 

  40. 

  41. .. _class_AudioEffectSpectrumAnalyzerInstance_method_get_magnitude_for_frequency_range:
    42. 

  42. 

  43. - :ref:`Vector2<class_Vector2>` **get_magnitude_for_frequency_range** **(** :ref:`float<class_float>` from_hz, :ref:`float<class_float>` to_hz, :ref:`MagnitudeMode<enum_AudioEffectSpectrumAnalyzerInstance_MagnitudeMode>` mode=1 **)** |const|
    44. 

  44. 

  45. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    46. 

  46. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    47. 

  47. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    48. 

  48.