class_audioeffectamplify.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectAmplify.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectAmplify:
  6. AudioEffectAmplify
  7. ==================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Adds a Amplify audio effect to an Audio bus.
  13. Increases or decreases the volume of the selected audio bus.
  14. Properties
  15. ----------
  16. +---------------------------+---------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` |
  18. +---------------------------+---------------------------------------------------------------+
  19. Description
  20. -----------
  21. Increases or decreases the volume being routed through the audio bus.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_AudioEffectAmplify_property_volume_db:
  25. - :ref:`float<class_float>` **volume_db**
  26. +----------+----------------------+
  27. | *Setter* | set_volume_db(value) |
  28. +----------+----------------------+
  29. | *Getter* | get_volume_db() |
  30. +----------+----------------------+
  31. Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``.