BANDPASS is a filter that only passes (lets through) an adjustable-sized band of frequencies. All other frequencies are suppressed. This can be used for special-fx sounds such as the “megaphone” sound popular in some modern rock music, or a telephone or small speaker sound, by greatly limiting the frequency range of the original sound (by setting BANDPASS_WIDTH
to a relatively small value). By using a wider frequency range (setting BANDPASS_WIDTH to a higher value), sounds that appear “too big” for a mix may be made to sound a little smaller so that they blend better with other sounds in the mix.
BANDPASS_FREQ
is the center frequency (in Hz) of the window of frequencies to pass through.
default: 800.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, BANDPASS, BANDPASS_FREQ, 200)
BANDPASS_WIDTH
is the width (in Hz) of the window of frequencies to let through.
default: 0.5
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, BANDPASS, BANDPASS_WIDTH, 0.3)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 0.1
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, BANDPASS, MIX, 0.3)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, BANDPASS, BYPASS, 0.0)
CHORUS
chorus
CHORUS
creates various copies of the original sound which get varied slightly in pitch and time, and mixed back in to the sound, creating an ensemble-like effect of many voices playing together. At extreme values of parameter settings, artificial “robot-like” sounds can be heard.
CHORUS_LENGTH
is the length of time (in ms) from the original sound within which the chorus effect is activated.
default: 15.0
minValue: 1.0
maxValue: 250.0
Example
setEffect(1, CHORUS, CHORUS_LENGTH, 53.0)
CHORUS_NUMVOICES
is the number of copies of the original sound that is used. Larger values create a bigger ensemble-like effect.
default: 1.0
minValue: 1.0
maxValue: 8.0
Example
setEffect(1, CHORUS, CHORUS_NUMVOICES, 4.0)
CHORUS_RATE
is the rate (in Hz) which the pitch cycles or “wobbles” at. Lower values create smoothly-cycling sounds, while higher values create more wobbly-sounding effects.
default: 0.5
minValue: 0.1
maxValue: 16.0
Example
setEffect(1, CHORUS, CHORUS_RATE, 3.0)
CHORUS_MOD
is the depth of the pitch wobbling (i.e. how much pitch cycling is used). Low settings create a more natural sound, while higher settings create a more artificial-like sound.
default: 0.7
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, CHORUS, CHORUS_MOD, 0.4)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, CHORUS, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, CHORUS, BYPASS, 1.0)
COMPRESSOR
compressor
COMPRESSOR
is a basic two-parameter compressor, which reduces the volume of the loudest sounds of the effected track, while amplifying the volume of its quietest sounds. This creates a narrower dynamic range from the original sound, and is often used to maximize the punch of the original sound, while reducing the potential for noise to be added later.
COMPRESSOR_THRESHOLD
is the amplitude (volume) level (in dB) above which the compressor starts to reduce volume.
default: 0.0
minValue: -12.0
maxValue: 1.0
Example
setEffect(1, COMPRESSOR, COMPRESSOR_THRESHOLD, -4.0)
COMPRESSOR_RATIO
is the amount of specified gain reduction. A ratio of 3:1 means that if the original sound is 3 dB over the threshold, then the effected sound will be 1 dB over the threshold.
default: 1.0
minValue: 1.0
maxValue: 50.0
Example
setEffect(1, COMPRESSOR, COMPRESSOR_RATIO, 35.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, COMPRESSOR, BYPASS, 1.0)
DELAY
delay
DELAY
creates a repeated echo-like delay of the original sound. A delay effect plays back the original audio as well as a delayed, quieter version of the original that sounds like an echo. After the first echo it plays an echo of the echo (even quieter), then an echo of the echo of the echo (still quieter), and so on until the echo dies out to nothing. With the delay effect, we can control how much time passes between each echo (delay time). If we set the delay time to match the length of a beat, we can create rhythmic effects with delay.
DELAY_TIME
is the time amount in milliseconds (ms) that the original track is delayed, and the time between successive repeats of the delay.
default: 300.0
minValue: 0.0
maxValue: 4000.0
Example
setEffect(1, DELAY, DELAY_TIME, 1200.0)
DELAY_FEEDBACK
is the relative amount of repeats that the delay generates. Higher values create more “echoes”. Be careful of applying “too much” feedback!
default: -3.0
minValue: -120.0
maxValue: -1.0
Example
setEffect(1, DELAY, DELAY_FEEDBACK, -20.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, DELAY, MIX, 0.4)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, DELAY, BYPASS, 1.0)
DISTORTION
distortion
DISTORTION creates a “dirty” or “fuzzy” sound by overdriving the original sound. This compresses or clips the sound wave, adding overtones (higher frequencies related to the original sound). It is common to distort an electric guitar sound by “overdriving” the guitar amplifier. Modern music sometimes uses distortion to add a grungy or gritty effect or feel to the composition.
DISTO_GAIN
is the amount of overdrive of the original sound.
default: 20.0
minValue: 0.0
maxValue: 50.0
Example
setEffect(1, DISTORTION, DISTO_GAIN, 25.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, DISTORTION, MIX, 0.15)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, DISTORTION, BYPASS, 1.0)
EQ3BAND
eq3band
EQ3BAND
is a three-band equalizer used for simple EQ tasks. An equalizer is used to adjust the volume of separate ranges of frequencies within an audio track. This particular effect can be used to adjust the volume of three ranges (“bands”) of frequency content, namely bass, midrange, and treble (low, mid, high), where the upper border (EQ3BAND_LOWFREQ
) of the low range and the center frequency of the mid range (EQ3BAND_MIDFREQ
) may be set by the user.
EQ3BAND_LOWGAIN
is the gain (in dB) of the low range of frequencies of the EQ. Negative values lower the volume of the low frequencies, while positive values boost them.
default: 0.0
minValue: -24.0
maxValue: 18.0
Example
setEffect(1, EQ3BAND, EQ3BAND_LOWGAIN, 5.3)
EQ3BAND_LOWFREQ
specifies the highest frequency (in Hz) of the low range.
default: 200.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, EQ3BAND, EQ3BAND_LOWFREQ, 700.0)
EQ3BAND_MIDGAIN
is the gain (in dB) of the mid range of frequencies of the EQ. Negative values lower the volume of the mid frequencies, while positive values boost them.
default: 0.0
minValue: -24.0
maxValue: 18.0
Example
setEffect(1, EQ3BAND, EQ3BAND_MIDGAIN, -15.0)
EQ3BAND_MIDFREQ
specifies the center frequency (in Hz) of the mid range.
default: 2000.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, EQ3BAND, EQ3BAND_MIDFREQ, 1200.0)
EQ3BAND_HIGAIN
is the gain (in dB) of the high range of frequencies of the EQ. Negative values lower the volume of the high frequencies, while positive values boost them.
default: 0.0
minValue: -24.0
maxValue: 18.0
Example
setEffect(1, EQ3BAND, EQ3BAND_HIGAIN, 10.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, EQ3BAND, BYPASS, 1.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, EQ3BAND, MIX, 0.4)
FILTER
filter
FILTER
is a standard low-pass filter with resonance. A low-pass filter effect allows low frequency audio to pass through unchanged, while lowering the volume of the higher frequencies above a cutoff frequency (the FILTER_FREQ
parameter). This gives the audio a “darker” sound.
FILTER_FREQ
is the cutoff frequency (Hz), which means that all frequencies higher than this value are rolled-off (become lower and lower in volume the higher they are from this value).
default: 1000.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, FILTER, FILTER_FREQ, 3000.0)
FILTER_RESONANCE
is the amount of amplification of a narrow band of frequencies around the current FILTER_FREQ
level. This causes the frequencies around the current FILTER_FREQ
level to ring out more, to sound more “resonant”. It effectively creates a more vibrant, ringing sound around the cutoff frequency (FILTER_FREQ
). Higher values of resonance will make the filter “sharper” around the FILTER_FREQ
, which accentuates the frequencies closest to the cutoff frequency. This is a subtle parameter that helps fine-tune the sound of the filter.
default: 0.8
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, FILTER, FILTER_RESONANCE, 0.0, 1.0, 0.9, 3.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, FILTER, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, FILTER, BYPASS, 1.0)
FLANGER
flanger
FLANGER
is similar to a chorus effect, where various copies of the original sound are created which get varied slightly in pitch and time, and mixed back in to the sound. A flanger, however, uses a much finer range of time values, which creates an evolving “whoosh” like sound. At extreme values of parameter settings, more artificial “robot-like” sounds can be heard.
FLANGER_LENGTH
is the length of delay time (in ms) from the original sound within which the flanger effect is activated.
default: 6.0
minValue: 0.0
maxValue: 200.0
Example
setEffect(1, FLANGER, FLANGER_LENGTH, 23.0)
FLANGER_FEEDBACK
is the amount (in dB) that the effected sound is “fed back” into the effect. Higher values create more artificial-like sounds.
default: -50.0
minValue: -80.0
maxValue: -1.0
Example
setEffect(1, FLANGER, FLANGER_FEEDBACK, -80.0)
FLANGER_RATE
is the rate (in Hz) which the pitch cycles or “whooshes” at. Lower values create more smoothly-cycling sounds, while higher values create more whooshing-sounding effects and sonic artifacts.
default: 0.6
minValue: 0.001
maxValue: 100.0
Example
setEffect(1, FLANGER, FLANGER_RATE, 45.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, FLANGER, MIX, 0.7)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, FLANGER, BYPASS, 0.0)
IMAGE
image
IMAGE
can be used to create a stereo image of the original sound, where the left and right channels are delayed slightly either before or after the original sound.
IMAGE_LEFTDELAY
is the delay time (in ms) of the left channel. Negative values create a pre-delay (before the original sound!), while positive values create a “normal” post-delay.
default: 0.0
minValue: -100.0
maxValue: 100.0
Example
setEffect(1, IMAGE, IMAGE_LEFTDELAY, 45.0)
IMAGE_RIGHTDELAY
is the delay time (in ms) of the right channel. Negative values create a pre-delay (before the original sound!), while positive values create a “normal” post-delay.
default: 0.0
minValue: -100.0
maxValue: 100.0
Example
setEffect(1, IMAGE, IMAGE_RIGHTDELAY, -50.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, IMAGE, MIX, 0.1)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, IMAGE, BYPASS, 1.0)
NOISEGATE
noisegate
NOISEGATE
is an effect that silences the original sound whenever its volume falls below a certain threshold level. This effect can sound great on drum loops, by introducing more space (silence) between the loudest hits. Experiment with different parameter settings to get the best sounding response for any given sound.
NOISEGATE_THRESHOLD
is the volume level (in dB) under which the original sound is silenced, by the noise gate “closing”.
default: -60.0
minValue: -120.0
maxValue: 6.0
Example
setEffect(1, NOISEGATE, NOISEGATE_THRESHOLD, -10.0)
NOISEGATE_FADETIME
is the time (in ms) of fade out to silence after the noise gate closes.
default: 50.0
minValue: 1.0
maxValue: 4000.0
Example
setEffect(1, NOISEGATE, NOISEGATE_FADETIME, 300.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, NOISEGATE, BYPASS, 1.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, NOISEGATE, MIX, 0.2)
PAN
Pan: pan
PAN affects the audio mix between the left and right channels. For example, if you were wearing headphones, changing the panning would affect whether you heard something from the left earcub or the right.
LEFT_RIGHT
specifies the left/right location of the original sound within the stereo field (0.0 is center, -100.0 is fully left, 100.0 is fully right).
default: 0.0
minValue: -100.0
maxValue: 100.0
Example
setEffect(1, PAN, LEFT_RIGHT, -50.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PAN, BYPASS, 1.0)
PARAM_EQ
param_eq
PARAM_EQ
is a single-band equalizing filter used for boosting or cutting (turning the volume up or down for) one particular band of frequencies, with adjustable width around a center frequency. This effect is usually used to pinpoint and cut an annoying frequency range, or for boosting a selected frequency range to give it more presence in the overall mix.
PARAMETRIC_BAND
is the center frequency around which to adjust.
default: 4000.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, PARAM_EQ, PARAMETRIC_BAND, 2000.0)
PARAMETRIC_GAIN
is the amount of cutting (negative values) or boosting (positive values) of the frequency band.
default: 0.0
minValue: -15.0
maxValue: 15.0
Example
setEffect(1, PARAM_EQ, PARAMETRIC_GAIN, -2.0)
PARAMETRIC_WIDTH
is the width of the frequency band around the center frequency (PARAMETRIC_BAND
).
default: 0.7
minValue: 0.01
maxValue: 50.0
Example
setEffect(1, PARAM_EQ, PARAMETRIC_WIDTH, 33.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PARAM_EQ, BYPASS, 1.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PARAM_EQ, MIX, 1.0)
PHASER
phaser
PHASER
is a sweeping-sounding effect which creates a copy of the original sound over a specified range of frequencies. This effected copy is then delayed very slightly and played against the original sound while changing its slight delay time gently back and forth. This causes some of the copied frequencies to temporarily cancel each other out by going “in and out of phase” with each other, thus creating a sweeping effect.
PHASER_RATE
is the rate (in Hz) that the slight delay time changes back and forth. Lower values create more smoothly-cycling sounds, while higher values create more robotic-sounding effects and sonic artifacts.
default: 0.5
minValue: 0.0
maxValue: 10.0
Example
setEffect(1, PHASER, PHASER_RATE, 3.0)
PHASER_RANGEMIN
is the low value (in Hz) of the affected frequency range.
default: 440.0
minValue: 40.0
maxValue: 20000.0
Example
setEffect(1, PHASER, PHASER_RANGEMIN, 880.0)
PHASER_RANGEMAX
is the high value (in Hz) of the affected frequency range.
default: 1600.0
minValue: 40.0
maxValue: 20000.0
Example
setEffect(1, PHASER, PHASER_RANGEMAX, 4000.0)
PHASER_FEEDBACK
is the amount that the effected sound is “fed back” into the effect. Higher values create more artificial-like sounds.
default: -3.0
minValue: -120.0
maxValue: -1.0
Example
setEffect(1, PHASER, PHASER_FEEDBACK, -1.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PHASER, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PHASER, BYPASS, 1.0)
PITCHSHIFT
pitchshift
PITCHSHIFT
simply lowers or raises the sound by a specific pitch interval (PITCHSHIFT_SHIFT
). It can be useful in helping multiple sound files sound better together or, contrastingly, to add a little bit of dissonance, if desired. It can also be used to create a harmony part for the same track by keeping the PITCHSHIFT_MIX
setting somewhere towards its central position (0.5), to balance the volume between the effect and the original sound.
PITCHSHIFT_SHIFT
specifies the amount to adjust the pitch of the original sound in semitones (and fractions of a semitone, given by values after the decimal point). 12 semitones equal 1 octave.
default: 0.0
minValue: -12.0
maxValue: 12.0
Example
setEffect(1, PITCHSHIFT, PITCHSHIFT_SHIFT, 4.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PITCHSHIFT, MIX, 0.3)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, PITCHSHIFT, BYPASS, 1.0)
REVERSER
reverser
REVERSER
is an effect that consistently reverses an area of time after the current location of the original sound.
REVERSER_LENGTH
is the length of time (in ms) after the current location of the original sound that gets reversed by the effect.
default: 500.0
minValue: 0.0
maxValue: 4000.0
Example
setEffect(1, REVERSER, REVERSER_LENGTH, 1000.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, REVERSER, MIX, 0.7)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, REVERSER, BYPASS, 1.0)
RINGMOD
ringmod
RINGMOD
multiplies the signals from two sounds together: your original sound and a pure sine wave (that sounds like a tuning fork). The effect of this multiplication sounds different at every frequency of the original sound, which creates a completely artificial-sounding result, as this type of sound could never occur naturally. Some parameter settings for this effect will likely produce recognizable-sounding effects similar to ones used in old science-fiction movies. It is useful experimenting with since there are a wide range of sounds that can be generated from your original sound.
RINGMOD_MODFREQ
is the frequency (in Hz) of the sine wave oscillator that is being multiplied into your original sound.
default: 40.0
minValue: 0.0
maxValue: 100.0
Example
setEffect(1, RINGMOD, RINGMOD_MODFREQ, 70.0)
RINGMOD_FEEDBACK
is the amount of effected sound that is fed-back into the effect. High values create more robotic-type sounds and sonic artifacts.
default: 0.0
minValue: 0.0
maxValue: 100.0
Example
setEffect(1, RINGMOD, RINGMOD_FEEDBACK, 30.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, RINGMOD, MIX, 0.1)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, RINGMOD, BYPASS, 1.0)
SWEEPER
sweeper
SWEEPER
is a sweeping low-pass filter with resonance. It rolls-off (suppresses) higher frequency content and “passes” lower frequency content, according to the setting of its cutoff frequency (somewhere between SWEEPER_FREQ1
and SWEEPER_FREQ2)
. The effect “sweeps” between these two frequencies in real time, creating a moving fx sound, which becomes more pronounced the higher the SWEEPER_RESONANCE
is set to, which creates a thicker, more resonant sound around the cutoff frequency.
SWEEPER_FREQ1
is the first cutoff frequency (in Hz) to use for the sweeping effect.
default: 1000.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, SWEEPER, SWEEPER_FREQ1, 5000.0)
SWEEPER_FREQ2
is the second cutoff frequency (in Hz) to use for the sweeping effect.
default: 2000.0
minValue: 20.0
maxValue: 20000.0
Example
setEffect(1, SWEEPER, SWEEPER_FREQ2, 5000.0)
SWEEPER_SWEEPTIME
is the time (in ms) it takes to sweep from SWEEPER_FREQ1 to SWEEPER_FREQ2.
default: 2.0
minValue: 0.1
maxValue: 30.0
Example
setEffect(1, SWEEPER, SWEEPER_SWEEPTIME, 4.0)
SWEEPER_RESONANCE
is the amount of amplification of a narrow band of frequencies around the current cutoff frequency level (given by the current position of the sweeping effect between SWEEPER_FREQ1
and SWEEPER_FREQ2
). This causes the frequencies around the current cutoff level to “sing out” more, to sound more “resonant”.
default: 0.8
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, SWEEPER, SWEEPER_RESONANCE, 0.3)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, SWEEPER, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, SWEEPER, BYPASS, 1.0)
TREMOLO
tremolo
TREMOLO
quickly changes the volume of the original sound back and forth from its original value towards silence, resulting in a wobbling-sounding effect.
TREMOLO_FREQ
is the rate (in Hz) that the volume is changed back and forth.
default: 4.0
minValue: 0.0
maxValue: 100.0
Example
setEffect(1, TREMOLO, TREMOLO_FREQ, 10.0)
TREMOLO_AMOUNT
is the amount (in dB) that the volume changes back and forth over during each cycle.
default: -6.0
minValue: -60.0
maxValue: 0.0
Example
setEffect(1, TREMOLO, TREMOLO_AMOUNT, -40.0)
TREMOLO_STEREOWIDTH
is the amount of stereo spread of the effect between the left and right speakers.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, TREMOLO, TREMOLO_STEREOWIDTH, 0.25)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, TREMOLO, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, TREMOLO, BYPASS, 1.0)
VARLEN_DELAY
varlen_delay
VARLEN_DELAY
creates a wobbling delay/echo effect (see DELAY
effect) where the delay time is constantly speeding up and slowing down.
VARLEN_TIME
is the central delay time used, the value from which the speeding up and slowing down begins at.
default: 300.0
minValue: 0.0
maxValue: 4000.0
Example
setEffect(1, VARLEN_DELAY, VARLEN_TIME, 1000.0)
VARLEN_PERIOD
is the length of time in seconds that it takes to perform one whole “speeding-up slowing down” cycle. Experiment using different values here to get a feel for what this parameter controls.
default: 1.0
minValue: 0.001
maxValue: 30.0
Example
setEffect(1, VARLEN_DELAY, VARLEN_PERIOD, 2.0)
VARLEN_AMP
is the amount of the “speeding-up slowing down” that is applied. Low values create a flanging effect, while high values create a more jumbled sound.
default: 0.3
minValue: 0.001
maxValue: 1.0
Example
setEffect(1, VARLEN_DELAY, VARLEN_AMP, 0.2)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, VARLEN_DELAY, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, VARLEN_DELAY, BYPASS, 1.0)
VOLUME
Volume:
volume
VOLUME
allows you to change the volume of an audio clip.
GAIN
specifies the output volume level of the original sound.
default: 0.0
minValue: -60.0
maxValue: 12.0
Example
setEffect(1, VOLUME, GAIN, -5.0)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, VOLUME, BYPASS, 1.0)
WAH
WAH
is a resonant bandpass filter (see BANDPASS
effect) that creates a “wah-wah” pedal sound when changed over time using envelopes in the setEffect() function.
wah <– in this example, the WAH_POSITION parameter is changed over time by an envelope
WAH_POSITION
is the center frequency of the boosted fixed-width frequency range.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAH, WAH_POSITION, 0.3)
WAH_RESOTOP
is the amount of resonance (see FILTER
effect for explanation) around the top of the frequency range whose center is determined by the WAH_POSITION
setting. Higher values create more ringing (resonance) around the higher frequencies.
default: 0.7
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAH, WAH_RESOTOP, 0.8)
WAH_RESOBOTTOM
is the amount of resonance (see FILTER
effect) around the bottom of the frequency range whose center is determined by the WAH_POSITION
setting. Higher values create more ringing (resonance) around the lower frequencies.
default: 0.1
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAH, WAH_RESOBOTTOM, 0.3)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAH, MIX, 0.3)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAH, BYPASS, 1.0)
WAVESHAPER
waveshaper
WAVESHAPER
is a type of distortion (see DISTORTION
effect) in which the original soundwave is slightly altered or “bent” at certain locations, causing clipping and higher overtones to be added to the sound. At low levels it can make a sound more vibrant and stand out more. At higher levels the sound becomes more distorted, which can work fine for some sounds while making others sound like they are being played through a damaged set of speakers.
WAVESHAPER_AMOUNT
is the amount of waveshaping distortion to add. Usually there is a value just under which most of the distortion disappears for a given sound.
default: 0.0
minValue: 0.0
maxValue: 100.0
Example
setEffect(1, WAVESHAPER, WAVESHAPER_AMOUNT, 30.0)
MIX
is the percentage of the effected sound (wet) that is mixed with the original sound (dry). At its minimum value (0.0), no effect can be heard. At its maximum value (1.0), none of the original sound is heard – it is all effect.
default: 1.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAVESHAPER, MIX, 0.5)
BYPASS
is whether the effect is “on” (1.0) or “off” (0.0). If the bypass of an effect is “on” (1.0), that means the audio going into the effect passes through, and comes out unaffected. Note that unlike other effect name/parameter pairs, the only valid values for BYPASS are 0.0 and 1.0.
default: 0.0
minValue: 0.0
maxValue: 1.0
Example
setEffect(1, WAVESHAPER, BYPASS, 1.0)