Echo

with_fx :echo do
play 50
end

amp:

1

amp_slide:

0

mix:

1

mix_slide:

0

pre_amp:

1

pre_amp_slide:

0

phase:

0.25

phase_slide:

0

decay:

2

decay_slide:

0

max_phase:

2

Standard echo with variable phase duration (time between echoes) and decay (length of echo fade out). If you wish to have a phase duration longer than 2s, you need to specifiy the longest phase duration you'd like with the arg max_phase. Be warned, echo FX with very long phases can consume a lot of memory and take longer to initialise.

 amp:

The amplitude of the sound. Typically a value between 0 and 1. Higher amplitudes may be used, but won't make the sound louder, it will just reduce the quality of all the sounds currently being played (due to compression.)
Default: 1
must be zero or greater
May be changed whilst playing

 amp_slide:

Amount of time (in seconds) for the amplitude (amp) to change. A long slide value means that the amp takes a long time to slide from the previous amplitude to the new amplitude. A slide of 0 means that the amplitude instantly changes to the new amplitude.
Default: 0
must be zero or greater
May be changed whilst playing

 mix:

The amount (percentage) of FX present in the resulting sound represented as a value between 0 and 1. For example, a mix of 0 means that only the original sound is heard, a mix of 1 means that only the FX is heard (typically the default) and a mix of 0.5 means that half the original and half of the FX is heard.
Default: 1
must be a value between 0 and 1 inclusively
May be changed whilst playing

 mix_slide:

Amount of time (in seconds) for the mix value to change. A long slide value means that the mix takes a long time to slide from the previous value to the new value. A slide of 0 means that the mix instantly changes to the new value.
Default: 0
must be zero or greater
May be changed whilst playing

 pre_amp:

Amplification applied to the input signal immediately before it is passed to the FX.
Default: 1
must be zero or greater
May be changed whilst playing

 pre_amp_slide:

Amount of time (in seconds) for the pre_amp value to change. A long pre_amp_slide value means that the pre_amp takes a long time to slide from the previous value to the new value. A pre_amp_slide of 0 means that the pre_amp instantly changes to the new value.
Default: 0
must be zero or greater
May be changed whilst playing

 phase:

The time between echoes in seconds.
Default: 0.25
must be greater than zero
May be changed whilst playing

 phase_slide:

Slide time in seconds between phase values
Default: 0
must be zero or greater
May be changed whilst playing

 decay:

The time it takes for the echoes to fade away in seconds.
Default: 2
must be greater than zero
May be changed whilst playing

 decay_slide:

Slide time in seconds between decay times
Default: 0
must be zero or greater
May be changed whilst playing

 max_phase:

The maximum phase duration in seconds.
Default: 2
must be greater than zero
Can not be changed once set