class_audioeffectamplify.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectAmplify.xml.
  6. .. _class_AudioEffectAmplify:
  7. AudioEffectAmplify
  8. ==================
  9. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Adds an amplifying audio effect to an audio bus.
  11. Increases or decreases the volume of the selected audio bus.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Increases or decreases the volume being routed through the audio bus.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +---------------------------+---------------------------------------------------------------+---------+
  22. | :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | ``0.0`` |
  23. +---------------------------+---------------------------------------------------------------+---------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_AudioEffectAmplify_property_volume_db:
  30. .. rst-class:: classref-property
  31. :ref:`float<class_float>` **volume_db** = ``0.0``
  32. .. rst-class:: classref-property-setget
  33. - void **set_volume_db** **(** :ref:`float<class_float>` value **)**
  34. - :ref:`float<class_float>` **get_volume_db** **(** **)**
  35. Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`