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
|
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
|
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.
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
|
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
|
res: |
Filter resonance as a value between 0 and 1. Only functional if a cutoff value is specified. Large amounts of resonance (a res: near 1) can create a whistling sound around the cutoff frequency. Smaller values produce less resonance.
Default: 0
must be zero or greater,must be a value less than 1
May be changed whilst playing
|
cutoff: |
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: 0
must be zero or greater,must be a value less than 131
May be changed whilst playing
|
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]
|