Echo

amp: 1 mix: 1 pre_mix: 1 pre_amp: 1
phase: 0.25 decay: 2 max_phase: 2

with_fx :echo

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 specify 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

Options

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, they 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 options 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 options to shape changes

pre_mix:

The amount (percentage) of the original signal that is fed into the internal FX system as a value between 0 and 1. With a pre_mix: of 0 the FX is completely bypassed unlike a mix: of 0 where the internal FX is still being fed the original signal but the output of the FX is ignored. The difference between the two is subtle but important and is evident when the FX has a residual component such as echo or reverb. When switching mix: from 0 to 1, the residual component of the FX’s output from previous audio is present in the output signal. With pre_mix: there is no residual component of the previous audio in the output signal.

Default: 1
Must be zero or greater
May be changed whilst playing
Has slide options 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 options to shape changes

phase:

The time between echoes in beats.

Default: 0.25
Must be greater than zero
May be changed whilst playing
Has slide options to shape changes
Scaled with current BPM value

decay:

The time it takes for the echoes to fade away in beats.

Default: 2
Must be greater than zero
May be changed whilst playing
Has slide options to shape changes
Scaled with current BPM value

max_phase:

The maximum phase duration in beats.

Default: 2
Must be greater than zero
Can not be changed once set
Scaled with current BPM value