# Ambient Sounds

| ``
     sample :ambi_soft_buzz
| ``
     sample :ambi_swoosh
| ``
     sample :ambi_drone
| ``
     sample :ambi_glass_hum
| ``
     sample :ambi_glass_rub
| ``
     sample :ambi_haunted_hum
| ``
     sample :ambi_piano
| ``
     sample :ambi_lunar_land
| ``
     sample :ambi_dark_woosh
| ``
     sample :ambi_choir
| ``
     sample :ambi_sauna

amp: | 1 | pre_amp: | 1 | pan: | 0 | attack: | 0
decay: | 0 | sustain: | -1 | release: | 0 | lpf: | -1
lpf_attack: | attack | lpf_decay: | decay | lpf_sustain: | sustain | lpf_release: | release
lpf_init_level: | lpf_min | lpf_attack_level: | lpf_decay_level | lpf_decay_level: | lpf_sustain_level | lpf_sustain_level: | lpf_release_level
lpf_release_level: | lpf | lpf_env_curve: | 2 | lpf_min: | 130 | hpf: | -1
hpf_attack: | attack | hpf_sustain: | sustain | hpf_decay: | decay | hpf_release: | release
hpf_init_level: | 130 | hpf_attack_level: | hpf_decay_level | hpf_decay_level: | hpf_sustain_level | hpf_sustain_level: | hpf_release_level
hpf_release_level: | hpf | hpf_env_curve: | 2 | hpf_max: | 200 | attack_level: | 1
decay_level: | sustain_level | sustain_level: | 1 | env_curve: | 2 | rate: | 1
start: | 0 | finish: | 1 | norm: | 0 | pitch: | 0
window_size: | 0.2 | pitch_dis: | 0.0 | time_dis: | 0.0 | compress: | 0
threshold: | 0.2 | clamp_time: | 0.01 | slope_above: | 0.5 | slope_below: | 1
relax_time: | 0.01

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
pre_amp: | Amplitude multiplier which takes place immediately before any internal FX such as the low pass filter, compressor or pitch modification. Use this opt if you want to overload the compressor. Default: 1 must be zero or greater May be changed whilst playing Has slide options to shape changes
pan: | Position of sound in stereo. With headphones on, this means how much of the sound is in the left ear, and how much is in the right ear. With a value of -1, the sound is completely in the left ear, a value of 0 puts the sound equally in both ears and a value of 1 puts the sound in the right ear. Values in between -1 and 1 move the sound accordingly. Default: 0 must be a value between -1 and 1 inclusively May be changed whilst playing Has slide options to shape changes
attack: | Duration of the attack phase of the envelope. Default: 0 must be zero or greater
decay: | Duration of the decay phase of the envelope. Default: 0 must be zero or greater
sustain: | Duration of the sustain phase of the envelope. When -1 (the default) will auto-stretch. Default: -1 must either be a positive value or -1
release: | Duration of the release phase of the envelope. Default: 0 must be zero or greater
lpf: | Low pass filter cutoff value. A MIDI note representing the highest frequencies allowed to be present in the sound. A low value like 30 makes the sound round and dull, a high value like 100 makes the sound buzzy and crispy. Default: -1 must be zero or greater,must be a value less than 131 May be changed whilst playing Has slide options to shape changes
lpf_attack: | Attack time for low pass filter envelope. Amount of time (in beats) for sound to reach attack_level value. This envelope is bypassed if no lpf env opts are specified. Default value is set to match amp envelope's attack value. Default: attack must be zero or greater
lpf_decay: | Decay time for low pass filter envelope. Amount of time (in beats) for sound to move from `lpf_attack_level:` to the `lpf_sustain_level:`. This envelope is bypassed if no lpf env opts are specified. Default value is set to match amp envelope's decay value. Default: decay must be zero or greater
lpf_sustain: | Amount of time for low pass filter envelope value to remain at sustain level in beats. This envelope is bypassed if no lpf env opts are specified. When -1 (the default) will auto-stretch. Default: sustain must either be a positive value or -1
lpf_release: | Amount of time (in beats) for sound to move from `lpf_sustain_level:` to `lpf_release_level:`. This envelope is bypassed if no lpf env opts are specified. Default: release must be zero or greater
lpf_init_level: | The initial low pass filter envelope value as a MIDI note. This envelope is bypassed if no lpf env opts are specified. Default value is to match the `lpf_min:` opt. Default: lpf_min must be a value between 0 and 130 inclusively
lpf_attack_level: | The peak low pass filter envelope value after the attack phase as a MIDI note. This envelope is bypassed if no lpf env opts are specified. Default value is match the `lpf_decay_level:` opt. Default: lpf_decay_level must be a value between 0 and 130 inclusively
lpf_decay_level: | The level of the low pass filter envelope after the decay phase as a MIDI note. This envelope is bypassed if no lpf env opts are specified. Default value is to match the `lpf_sustain_level:` opt. Default: lpf_sustain_level must be a value between 0 and 130 inclusively
lpf_sustain_level: | The level of the low pass filter envelope after the sustain phase as a MIDI note. This envelope is bypassed if no lpf env opts are specified. Default value is to match the `lpf_release_level:` opt. Default: lpf_release_level must be a value between 0 and 130 inclusively
lpf_release_level: | The final value of the low pass filter envelope as a MIDI note. This envelope is bypassed if no lpf env opts are specified. Default value is to match the `lpf:` opt. Default: lpf must be a value between 0 and 130 inclusively
lpf_env_curve: | Select the shape of the curve between levels in the cutoff envelope. 1=linear, 2=exponential, 3=sine, 4=welch, 6=squared, 7=cubed Default: 2 must be one of the following values: [1, 2, 3, 4, 6, 7]
lpf_min: | The minimum low pass filter value. Default: 130 must be a value less than or equal to 130 May be changed whilst playing Has slide options to shape changes
hpf: | High pass filter cutoff value. A MIDI note representing the lowest frequencies allowed to be present in the sound. A high value like 100 makes the sound thin and whispy, a low value like 40 removes just the lower bass components of the sound. Default: -1 must be zero or greater,must be a value less than 119 May be changed whilst playing Has slide options to shape changes
hpf_attack: | Attack time for hpf cutoff filter. Amount of time (in beats) for sound to reach full hpf cutoff value. Default value is set to match amp envelope's attack value. Default: attack must be zero or greater
hpf_sustain: | Amount of time for hpf cutoff value to remain at hpf sustain level in beats. When -1 (the default) will auto-stretch. Default: sustain must either be a positive value or -1
hpf_decay: | Decay time for hpf cutoff filter. Amount of time (in beats) for sound to move from full hpf cutoff value (cutoff attack level) to the hpf cutoff sustain level. Default value is set to match amp envelope's decay value. Default: decay must be zero or greater
hpf_release: | Amount of time (in beats) for sound to move from hpf cutoff sustain value to hpf cutoff min value. Default value is set to match amp envelope's release value. Default: release must be zero or greater
hpf_init_level: | The initial high pass filter envelope value as a MIDI note. This envelope is bypassed if no hpf env opts are specified. Default value is set to 130 Default: 130 must be a value between 0 and 130 inclusively
hpf_attack_level: | The peak hpf cutoff (value of hpf cutoff at peak of attack) as a MIDI note. Default: hpf_decay_level must be a value between 0 and 130 inclusively
hpf_decay_level: | The level of hpf cutoff after the decay phase as a MIDI note. Default: hpf_sustain_level must be a value between 0 and 130 inclusively
hpf_sustain_level: | The sustain hpf cutoff (value of hpf cutoff at sustain time) as a MIDI note. Default: hpf_release_level must be a value between 0 and 130 inclusively
hpf_release_level: | The sustain hpf cutoff (value of hpf cutoff at sustain time) as a MIDI note. Default: hpf must be a value between 0 and 130 inclusively
hpf_env_curve: | Select the shape of the curve between levels in the hpf cutoff envelope. 1=linear, 2=exponential, 3=sine, 4=welch, 6=squared, 7=cubed Default: 2 must be one of the following values: [1, 2, 3, 4, 6, 7]
hpf_max: | The maximum high pass filter value. Default: 200 must be a value less than or equal to 130 May be changed whilst playing Has slide options to shape changes
attack_level: | Amplitude level reached after attack phase and immediately before decay phase Default: 1 must be zero or greater
decay_level: | Amplitude level reached after decay phase and immediately before sustain phase. Defaults to sustain_level unless explicitly set Default: sustain_level must be zero or greater
sustain_level: | Amplitude level reached after decay phase and immediately before release phase. Default: 1 must be zero or greater
env_curve: | Select the shape of the curve between levels in the envelope. 1=linear, 2=exponential, 3=sine, 4=welch, 6=squared, 7=cubed Default: 2 must be one of the following values: [1, 2, 3, 4, 6, 7]
rate: | Rate with which to play back - default is 1. Playing the sample at rate 2 will play it back at double the normal speed. This will have the effect of doubling the frequencies in the sample and halving the playback time. Use rates lower than 1 to slow the sample down. Negative rates will play the sample in reverse. Default: 1 must not be zero
start: | A fraction (between 0 and 1) representing where in the sample to start playback. 1 represents the end of the sample, 0.5 half-way through etc. Default: 0 must be a value between 0 and 1 inclusively
finish: | A fraction (between 0 and 1) representing where in the sample to finish playback. 1 represents the end of the sample, 0.5 half-way through etc. Default: 1 must be a value between 0 and 1 inclusively
norm: | Normalise the audio (make quieter parts of the sample louder and louder parts quieter) - this is similar to the normaliser FX. This may emphasise any clicks caused by clipping. Default: 0 must be one of the following values: [0, 1]
pitch: | Pitch adjustment in semitones. 1 is up a semitone, 12 is up an octave, -12 is down an octave etc. Maximum upper limit of 24 (up 2 octaves). Lower limit of -72 (down 6 octaves). Decimal numbers can be used for fine tuning. Default: 0 must be a value greater than or equal to -72,must be a value less than or equal to 24 May be changed whilst playing Has slide options to shape changes
window_size: | Pitch shift works by chopping the input into tiny slices, then playing these slices at a higher or lower rate. If we make the slices small enough and overlap them, it sounds like the original sound with the pitch changed. The window_size is the length of the slices and is measured in seconds. It needs to be around 0.2 (200ms) or greater for pitched sounds like guitar or bass, and needs to be around 0.02 (20ms) or lower for percussive sounds like drum loops. You can experiment with this to get the best sound for your input. Default: 0.2 must be a value greater than 5.0e-05 May be changed whilst playing Has slide options to shape changes
pitch_dis: | Pitch dispersion - how much random variation in pitch to add. Using a low value like 0.001 can help to "soften up" the metallic sounds, especially on drum loops. To be really technical, pitch_dispersion is the maximum random deviation of the pitch from the pitch ratio (which is set by the pitch param) Default: 0.0 must be a value greater than or equal to 0 May be changed whilst playing Has slide options to shape changes
time_dis: | Time dispersion - how much random delay before playing each grain (measured in seconds). Again, low values here like 0.001 can help to soften up metallic sounds introduced by the effect. Large values are also fun as they can make soundscapes and textures from the input, although you will most likely lose the rhythm of the original. NB - This won't have an effect if it's larger than window_size. Default: 0.0 must be a value greater than or equal to 0 May be changed whilst playing Has slide options to shape changes
compress: | Enable the compressor. This sits at the end of the internal FX chain immediately before the `amp:` opt. Therefore to drive the compressor use the `pre_amp:` opt which will amplify the signal before it hits any internal FX. The compressor compresses the dynamic range of the incoming signal. Equivalent to automatically turning the amp down when the signal gets too loud and then back up again when it's quiet. Useful for ensuring the containing signal doesn't overwhelm other aspects of the sound. Also a general purpose hard-knee dynamic range processor which can be tuned via the opts to both expand and compress the signal. Default: 0 must be one of the following values: [0, 1]
threshold: | Threshold value determining the break point between slope_below and slope_above. Only valid if the compressor is enabled by turning on the compress: opt. Default: 0.2 must be zero or greater May be changed whilst playing Has slide options to shape changes
clamp_time: | Time taken for the amplitude adjustments to kick in fully (in seconds). This is usually pretty small (not much more than 10 milliseconds). Also known as the time of the attack phase. Only valid if the compressor is enabled by turning on the compress: opt. Default: 0.01 must be zero or greater May be changed whilst playing Has slide options to shape changes
slope_above: | Slope of the amplitude curve above the threshold. A value of 1 means that the output of signals with amplitude above the threshold will be unaffected. Greater values will magnify and smaller values will attenuate the signal. Only valid if the compressor is enabled by turning on the compress: opt. Default: 0.5 May be changed whilst playing Has slide options to shape changes
slope_below: | Slope of the amplitude curve below the threshold. A value of 1 means that the output of signals with amplitude below the threshold will be unaffected. Greater values will magnify and smaller values will attenuate the signal. Only valid if the compressor is enabled by turning on the compress: opt. Default: 1 May be changed whilst playing Has slide options to shape changes
relax_time: | Time taken for the amplitude adjustments to be released. Usually a little longer than clamp_time. If both times are too short, you can get some (possibly unwanted) artefacts. Also known as the time of the release phase. Only valid if the compressor is enabled by turning on the compress: opt. Default: 0.01 must be zero or greater May be changed whilst playing Has slide options to shape changes

## Slide Options

Any parameter that is slidable has three additional options 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 beats) 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 *_slide_curve: opt e.g. amp_slide_curve:), 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