AudioEffectDelay.xml 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioEffectDelay" inherits="AudioEffect" version="4.0">
  3. <brief_description>
  4. Adds a delay audio effect to an audio bus. Plays input signal back after a period of time.
  5. Two tap delay and feedback options.
  6. </brief_description>
  7. <description>
  8. Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <members>
  13. <member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
  14. Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
  15. </member>
  16. <member name="feedback/active" type="bool" setter="set_feedback_active" getter="is_feedback_active" default="false">
  17. If [code]true[/code], feedback is enabled.
  18. </member>
  19. <member name="feedback/delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms" default="340.0">
  20. Feedback delay time in milliseconds.
  21. </member>
  22. <member name="feedback/level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db" default="-6.0">
  23. Sound level for [code]tap1[/code].
  24. </member>
  25. <member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass" default="16000.0">
  26. Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
  27. </member>
  28. <member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active" default="true">
  29. If [code]true[/code], [code]tap1[/code] will be enabled.
  30. </member>
  31. <member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms" default="250.0">
  32. [code]tap1[/code] delay time in milliseconds.
  33. </member>
  34. <member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db" default="-6.0">
  35. Sound level for [code]tap1[/code].
  36. </member>
  37. <member name="tap1/pan" type="float" setter="set_tap1_pan" getter="get_tap1_pan" default="0.2">
  38. Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right).
  39. </member>
  40. <member name="tap2/active" type="bool" setter="set_tap2_active" getter="is_tap2_active" default="true">
  41. If [code]true[/code], [code]tap2[/code] will be enabled.
  42. </member>
  43. <member name="tap2/delay_ms" type="float" setter="set_tap2_delay_ms" getter="get_tap2_delay_ms" default="500.0">
  44. [b]Tap2[/b] delay time in milliseconds.
  45. </member>
  46. <member name="tap2/level_db" type="float" setter="set_tap2_level_db" getter="get_tap2_level_db" default="-12.0">
  47. Sound level for [code]tap2[/code].
  48. </member>
  49. <member name="tap2/pan" type="float" setter="set_tap2_pan" getter="get_tap2_pan" default="-0.4">
  50. Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right).
  51. </member>
  52. </members>
  53. </class>