:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated from plugin XML; do not edit. .. XML source: https://github.com/LuYingYiLong/Godot-FmodPlayer/blob/42ed2e55ff623123a63c4cc535b02fd470996edd/doc_classes/FmodAudioEffectAmplify.xml .. _class_FmodAudioEffectAmplify: FmodAudioEffectAmplify ====================== **Inherits:** :ref:`FmodAudioEffect` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A simple gain/volume effect for amplifying or attenuating audio signals. .. rst-class:: classref-introduction-group Description ----------- FmodAudioEffectAmplify is a basic gain control effect that increases or decreases the volume of the audio signal. It provides both decibel (dB) and linear control over the amplification level. Use this effect for simple volume adjustments, boosting quiet signals, or attenuating loud signals in your audio pipeline. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`volume_db` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`volume_linear` | | +---------------------------+---------------------------------------------------------------------------+---------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_volume_db`\ (\ volume_db\: :ref:`float`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_volume_db`\ (\ ) |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_volume_linear`\ (\ volume_linear\: :ref:`float`\ ) | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_volume_linear`\ (\ ) |const| | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_FmodAudioEffectAmplify_property_volume_db: .. rst-class:: classref-property :ref:`float` **volume_db** = ``0.0`` .. rst-class:: classref-property-setget - |void| **set_volume_db**\ (\ volume_db\: :ref:`float`\ ) - :ref:`float` **get_volume_db**\ (\ ) |const| The amplification level in decibels (dB). Range: -80 dB to +24 dB. Default value of 0 dB means no change to the signal. Negative values attenuate the signal, positive values amplify it. .. rst-class:: classref-item-separator ---- .. _class_FmodAudioEffectAmplify_property_volume_linear: .. rst-class:: classref-property :ref:`float` **volume_linear** .. rst-class:: classref-property-setget - |void| **set_volume_linear**\ (\ volume_linear\: :ref:`float`\ ) - :ref:`float` **get_volume_linear**\ (\ ) |const| The amplification level as a linear value. It is converted to :ref:`volume_db` and clamped to that property's -80 to +24 dB range, corresponding to approximately 0.0001 to 15.8489. A value of 1.0 is unity gain; setting 0.0 produces the minimum gain rather than silence. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_FmodAudioEffectAmplify_method_set_volume_db: .. rst-class:: classref-method |void| **set_volume_db**\ (\ volume_db\: :ref:`float`\ ) Sets :ref:`volume_db`. .. rst-class:: classref-item-separator ---- .. _class_FmodAudioEffectAmplify_method_get_volume_db: .. rst-class:: classref-method :ref:`float` **get_volume_db**\ (\ ) |const| Returns :ref:`volume_db`. .. rst-class:: classref-item-separator ---- .. _class_FmodAudioEffectAmplify_method_set_volume_linear: .. rst-class:: classref-method |void| **set_volume_linear**\ (\ volume_linear\: :ref:`float`\ ) Sets :ref:`volume_linear`. .. rst-class:: classref-item-separator ---- .. _class_FmodAudioEffectAmplify_method_get_volume_linear: .. rst-class:: classref-method :ref:`float` **get_volume_linear**\ (\ ) |const| Returns :ref:`volume_linear`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`