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: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_audioeffect.rst

class_audioeffect.rst 2.8 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 
  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 AudioEffect.xml source instead.
    5. 

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

  6. 

  7. .. _class_AudioEffect:
    8. 

  8. 

  9. AudioEffect
    10. 

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

  11. 

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

  13. 

  14. **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>`
    15. 

  15. 

  16. Audio effect for audio.
    17. 

  17. 

  18. Description
    19. 

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

  20. 

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

  22. 

  23. Tutorials
    24. 

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

  25. 

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

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +-------------------------------------------------------+----------------------------------------------------------------------------------+
    32. 

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

  33. +-------------------------------------------------------+----------------------------------------------------------------------------------+
    34. 

  34. 

  35. Method Descriptions
    36. 

  36. -------------------
    37. 

  37. 

  38. .. _class_AudioEffect_method__instantiate:
    39. 

  39. 

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

  41. 

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

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

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

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

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

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