class_audioeffectamplify.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/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. Description
  13. -----------
  14. Increases or decreases the volume being routed through the audio bus.
  15. Properties
  16. ----------
  17. +---------------------------+---------------------------------------------------------------+---------+
  18. | :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | ``0.0`` |
  19. +---------------------------+---------------------------------------------------------------+---------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_AudioEffectAmplify_property_volume_db:
  23. - :ref:`float<class_float>` **volume_db**
  24. +-----------+----------------------+
  25. | *Default* | ``0.0`` |
  26. +-----------+----------------------+
  27. | *Setter* | set_volume_db(value) |
  28. +-----------+----------------------+
  29. | *Getter* | get_volume_db() |
  30. +-----------+----------------------+
  31. Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
  32. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  33. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  34. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`