AudioEffectDelay.xml 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.1">
  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. <demos>
  13. </demos>
  14. <methods>
  15. </methods>
  16. <members>
  17. <member name="dry" type="float" setter="set_dry" getter="get_dry">
  18. Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: [code]1[/code].
  19. </member>
  20. <member name="feedback/active" type="bool" setter="set_feedback_active" getter="is_feedback_active">
  21. If [code]true[/code], feedback is enabled. Default value: [code]false[/code].
  22. </member>
  23. <member name="feedback/delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms">
  24. Feedback delay time in milliseconds. Default value: [code]340[/code].
  25. </member>
  26. <member name="feedback/level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db">
  27. Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code].
  28. </member>
  29. <member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass">
  30. Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: [code]16000[/code].
  31. </member>
  32. <member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active">
  33. If [code]true[/code], [code]tap1[/code] will be enabled. Default value: [code]true[/code].
  34. </member>
  35. <member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms">
  36. [b]Tap1[/b] delay time in milliseconds. Default value: [code]250ms[/code].
  37. </member>
  38. <member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db">
  39. Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code].
  40. </member>
  41. <member name="tap1/pan" type="float" setter="set_tap1_pan" getter="get_tap1_pan">
  42. Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]0.2[/code].
  43. </member>
  44. <member name="tap2/active" type="bool" setter="set_tap2_active" getter="is_tap2_active">
  45. If [code]true[/code], [code]tap2[/code] will be enabled. Default value: [code]true[/code].
  46. </member>
  47. <member name="tap2/delay_ms" type="float" setter="set_tap2_delay_ms" getter="get_tap2_delay_ms">
  48. [b]Tap2[/b] delay time in milliseconds. Default value: [code]500ms[/code].
  49. </member>
  50. <member name="tap2/level_db" type="float" setter="set_tap2_level_db" getter="get_tap2_level_db">
  51. Sound level for [code]tap2[/code]. Default value: [code]-12 dB[/code].
  52. </member>
  53. <member name="tap2/pan" type="float" setter="set_tap2_pan" getter="get_tap2_pan">
  54. Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]-0.4[/code].
  55. </member>
  56. </members>
  57. <constants>
  58. </constants>
  59. </class>