Echo

with_fx :echo do
play 50
end

amp:

1

mix:

1

pre_amp:

1

phase:

0.25

decay:

2

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.

Introduced in v2.0

 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
Has slide parameters to shape changes

 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
Has slide parameters to shape changes

 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
Has slide parameters to shape changes
Scaled with current BPM value

 phase:

The time between echoes in seconds.
Default: 0.25
must be greater than zero
May be changed whilst playing
Has slide parameters to shape changes
Scaled with current BPM value

 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
Has slide parameters to shape changes
Scaled with current BPM value

 max_phase:

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

Slide Parameters

Any parameter that is slidable has three additional parameters named _slide, _slide_curve, and _slide_shape. For example, 'amp' is slidable, so you can also set amp_slide, amp_slide_curve, and amp_slide_shape with the following effects:

 _slide:

Amount of time (in seconds) for the parameter value to change. A long parameter_slide value means that the parameter takes a long time to slide from the previous value to the new value. A parameter_slide of 0 means that the parameter instantly changes to the new value.
Default: 0

 _slide_shape:

Shape of curve. 0: step, 1: linear, 3: sine, 4: welch, 5: custom (use curvature param), 6: squared, 7: cubed
Default: 5

 _slide_curve:

Shape of the slide curve (only honoured if slide shape is 5). 0 means linear and positive and negative numbers curve the segment up and down respectively.
Default: 0