2
0

class_audioeffectamplify.rst 1.4 KB

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