Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_audioeffect.rst

class_audioeffect.rst 2.9 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffect.xml.
    7. 

  7. 

  8. .. _class_AudioEffect:
    9. 

  9. 

  10. AudioEffect
    11. 

  11. ===========
    12. 

  12. 

  13. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. **Inherited By:** :ref:`AudioEffectAmplify<class_AudioEffectAmplify>`, :ref:`AudioEffectCapture<class_AudioEffectCapture>`, :ref:`AudioEffectChorus<class_AudioEffectChorus>`, :ref:`AudioEffectCompressor<class_AudioEffectCompressor>`, :ref:`AudioEffectDelay<class_AudioEffectDelay>`, :ref:`AudioEffectDistortion<class_AudioEffectDistortion>`, :ref:`AudioEffectEQ<class_AudioEffectEQ>`, :ref:`AudioEffectFilter<class_AudioEffectFilter>`, :ref:`AudioEffectLimiter<class_AudioEffectLimiter>`, :ref:`AudioEffectPanner<class_AudioEffectPanner>`, :ref:`AudioEffectPhaser<class_AudioEffectPhaser>`, :ref:`AudioEffectPitchShift<class_AudioEffectPitchShift>`, :ref:`AudioEffectRecord<class_AudioEffectRecord>`, :ref:`AudioEffectReverb<class_AudioEffectReverb>`, :ref:`AudioEffectSpectrumAnalyzer<class_AudioEffectSpectrumAnalyzer>`, :ref:`AudioEffectStereoEnhance<class_AudioEffectStereoEnhance>`
    16. 

  16. 

  17. Audio effect for audio.
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.
    23. 

  23. 

  24. Tutorials
    25. 

  25. ---------
    26. 

  26. 

  27. - `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`__
    28. 

  28. 

  29. Methods
    30. 

  30. -------
    31. 

  31. 

  32. +-------------------------------------------------------+----------------------------------------------------------------------------------+
    33. 

  33. | :ref:`AudioEffectInstance<class_AudioEffectInstance>` | :ref:`_instantiate<class_AudioEffect_method__instantiate>` **(** **)** |virtual| |
    34. 

  34. +-------------------------------------------------------+----------------------------------------------------------------------------------+
    35. 

  35. 

  36. Method Descriptions
    37. 

  37. -------------------
    38. 

  38. 

  39. .. _class_AudioEffect_method__instantiate:
    40. 

  40. 

  41. - :ref:`AudioEffectInstance<class_AudioEffectInstance>` **_instantiate** **(** **)** |virtual|
    42. 

  42. 

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

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

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

  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    47. 

  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    48. 

  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    49.