Files
godot-docs/classes/class_audioeffectamplify.rst
Rémi Verschelde 2b4319bc29 Sync classref with current source
Changes order of brief/long descriptions and removes category
as per godotengine/godot#35132.
2020-01-15 00:51:47 +01:00

47 lines
1.5 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectAmplify.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioEffectAmplify:
AudioEffectAmplify
==================
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Adds an amplifying audio effect to an audio bus.
Increases or decreases the volume of the selected audio bus.
Description
-----------
Increases or decreases the volume being routed through the audio bus.
Properties
----------
+---------------------------+---------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioEffectAmplify_property_volume_db>` | 0.0 |
+---------------------------+---------------------------------------------------------------+-----+
Property Descriptions
---------------------
.. _class_AudioEffectAmplify_property_volume_db:
- :ref:`float<class_float>` **volume_db**
+-----------+----------------------+
| *Default* | 0.0 |
+-----------+----------------------+
| *Setter* | set_volume_db(value) |
+-----------+----------------------+
| *Getter* | get_volume_db() |
+-----------+----------------------+
Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.