AudioEffectReverb.xml 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioEffectReverb" inherits="AudioEffect" version="4.0">
  3. <brief_description>
  4. Adds a reverberation audio effect to an Audio bus.
  5. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
  6. </brief_description>
  7. <description>
  8. Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
  9. </description>
  10. <tutorials>
  11. <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
  12. </tutorials>
  13. <members>
  14. <member name="damping" type="float" setter="set_damping" getter="get_damping" default="0.5">
  15. Defines how reflective the imaginary room's walls are. Value can range from 0 to 1.
  16. </member>
  17. <member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
  18. Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.
  19. </member>
  20. <member name="hipass" type="float" setter="set_hpf" getter="get_hpf" default="0.0">
  21. High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.
  22. </member>
  23. <member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback" default="0.4">
  24. Output percent of predelay. Value can range from 0 to 1.
  25. </member>
  26. <member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec" default="150.0">
  27. Time between the original signal and the early reflections of the reverb signal, in milliseconds.
  28. </member>
  29. <member name="room_size" type="float" setter="set_room_size" getter="get_room_size" default="0.8">
  30. Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
  31. </member>
  32. <member name="spread" type="float" setter="set_spread" getter="get_spread" default="1.0">
  33. Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.
  34. </member>
  35. <member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
  36. Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.
  37. </member>
  38. </members>
  39. </class>