| note: | 52 | amp: | 1 | pan: | 0 | attack: | 0 |
| decay: | 0 | sustain: | 0 | release: | 1 | attack_level: | 1 |
| decay_level: | sustain_level | sustain_level: | 1 | env_curve: | 2 | cutoff: | 100 |
| mod_phase: | 0.25 | mod_range: | 5 | mod_pulse_width: | 0.5 | mod_phase_offset: | 0 |
| mod_invert_wave: | 0 | mod_wave: | 1 |
use_synth :mod_sine
A sine wave passed through a low pass filter which modulates between two separate notes via a variety of control waves.
Introduced in v2.0
| 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. Full length of sound is attack + decay + sustain + release.
Default: 0
|
| decay: |
Amount of time (in beats) for the sound to move from full amplitude (attack_level) to the sustain amplitude (sustain_level).
Default: 0
|
| sustain: |
Amount of time (in beats) for sound to remain at sustain level amplitude. Longer sustain values result in longer sounds. Full length of sound is attack + decay + sustain + release.
Default: 0
|
| 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. Full length of sound is attack + decay + sustain + release.
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
|
| 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
|
| 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: 100
|
| mod_phase: |
Phase duration in beats of oscillations between the two notes. Time it takes to switch between the notes.
Default: 0.25
|
| mod_range: |
The size of gap between modulation notes. A gap of 12 is one octave.
Default: 5
|
| mod_pulse_width: |
The width of the modulated pulse wave as a value between 0 and 1. A width of 0.5 will produce a square wave. Only valid if mod wave is type pulse.
Default: 0.5
|
| mod_phase_offset: |
Initial modulation phase offset (a value between 0 and 1).
Default: 0
|
| mod_invert_wave: |
Invert mod waveform (i.e. flip it on the y axis). 0=normal wave, 1=inverted wave.
Default: 0
|
| mod_wave: |
Wave shape of mod wave. 0=saw wave, 1=pulse, 2=triangle wave and 3=sine wave.
Default: 1
|