2
0

AudioEffectAmplify.xml 1.2 KB

123456789101112131415161718192021
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioEffectAmplify" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Adds an amplifying audio effect to an audio bus.
  5. </brief_description>
  6. <description>
  7. Increases or decreases the volume being routed through the audio bus.
  8. </description>
  9. <tutorials>
  10. <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
  11. </tutorials>
  12. <members>
  13. <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
  14. Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
  15. </member>
  16. <member name="volume_linear" type="float" setter="set_volume_linear" getter="get_volume_linear">
  17. Amount of amplification as a linear value.
  18. [b]Note:[/b] This member modifies [member volume_db] for convenience. The returned value is equivalent to the result of [method @GlobalScope.db_to_linear] on [member volume_db]. Setting this member is equivalent to setting [member volume_db] to the result of [method @GlobalScope.linear_to_db] on a value.
  19. </member>
  20. </members>
  21. </class>