| note: | 52 | amp: | 1 | pan: | 0 | attack: | 0 |
| decay: | 0 | sustain: | 4 | release: | 1 | attack_level: | 1 |
| decay_level: | sustain_level | sustain_level: | 1 | clickiness: | 0.1 |
use_synth :kalimba
A synthesised kalimba (a type of African thumb piano). Note that due to the plucked nature of this synth the envelope opts such as attack:, sustain: and release: do not work as expected. They can only shorten the natural length of the note, not prolong it. Note the default envelope is longer than usual - sustain: 4 and release: 1
Introduced in v3.3
| note: |
Note to play. Either a MIDI number or a symbol representing a note. For example:
Default: 52
|
| 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
|
| 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
|
| attack: |
Amount of time (in beats) for sound to reach full amplitude (attack_level). A short attack (i.e. 0.01) makes the initial part of the sound very percussive like a sharp tap. A longer attack (i.e 1) fades the sound in gently. With the kalimba synth, this opt can only have the effect of shortening the attack phase, not prolonging it.
Default: 0
|
| decay: |
Amount of time (in beats) for the sound to move from full amplitude (attack_level) to the sustain amplitude (sustain_level). With the kalimba synth, this opt can only have the effect of controlling the amp within the natural duration of the note and can not prolong the sound.
Default: 0
|
| sustain: |
Amount of time (in beats) for sound to remain at sustain level amplitude. Longer sustain values result in longer sounds. With the kalimba synth, this opt can only have the effect of controlling the amp within the natural duration of the note and can not prolong the sound.
Default: 4
|
| release: |
Amount of time (in beats) for sound to move from sustain level amplitude to silent. A short release (i.e. 0.01) makes the final part of the sound very percussive (potentially resulting in a click). A longer release (i.e 1) fades the sound out gently. With the kalimba synth, this opt can only have the effect of controlling the amp within the natural duration of the note and can not prolong the sound.
Default: 1
|
| attack_level: |
Amplitude level reached after attack phase and immediately before decay phase
Default: 1
|
| decay_level: |
Amplitude level reached after decay phase and immediately before sustain phase. Defaults to sustain_level unless explicitly set
Default: sustain_level
|
| sustain_level: |
Amplitude level reached after decay phase and immediately before release phase.
Default: 1
|
| clickiness: |
Ratio of percussive click to melodic note in the sound. A low clickiness like 0.1 works well - higher values might give the impression that the instrument is being played harder. Very high values (towards 1) will be louder!
Default: 0.1
|