Link Search Menu Expand Document
Table of contents

Instrument

Every instrument has one Instrument module.

Parameter Description
Name Instrument name.
Blob Number The blob number to use when exporting the instrument to use in a GE-based product can be set here. Set to ‘-‘ to include a custom blob name in the Blob Path.
Blob Path Folder to save the .blob file (path should be relative to the instrument location).
Volume Volume for the whole instrument (leave at 0.0 dB to minimize CPU load). Often this parameter will be controlled by the instrument script to implement the master volume.
Tune Tuning for the whole instrument - note this is tuning of all samples, not transposition of the MIDI input.
Output Selects the main audio output - normally leave this set to 1.
Voices Displays the current number of voices the instrument is playing.
Sustain Pedal Sets the sustain pedal mode. Possible values are:
Off: No response to sustain pedal, so it can be handled in the instrument script.
On: Normal response to sustain pedal.
Latch: Sustain notes until the next note is played.
Damper: Sustained voices are not released while the sustain pedal is held, or the key that triggered the voice has been played again and is still held.
Glide Only has an effect in Group modules where the Glide mod source is used. Possible values are:
Off: No glide.
On: Always glide.
Auto: Only glide if a key is already held.
Default Keyswitch Sets which keyswitch key (if any) will be active when the instrument is loaded.
Pitch Bend Range Adjust maximum depth of all modulation routings from Pitch Bend to Group Tune.
Active Events Displays the number of script events currently active - useful for script debugging. Hanging events are most likely note events that were never released.
Script Defines List of words separated by spaces or commas, used with script USE_CODE_IF().
Overview Size Number of overview points to generate for samples (applied when exporting). Should be equal or greater than the width in pixels of the waveform display.
Simultaneous Max If set, limits the number of MIDI note and pedal messages in one audio buffer to reduce the maximum CPU load. Excess messages are delayed until the next audio buffer.
Group Solo Displays if any groups are currently soloed.
Bus Solo Displays if any effect busses are currently soloed.
Pitch Mod Range Adjust maximum depth of all modulation routings (except from Pitch Bend) to Group Tune. Warning: Playing samples at extremely high pitches can lead to aliasing, high CPU load, and drop-outs unless the whole sample is in RAM (using Start Mod Range in each Zone).
Groups Group
Mappings Mapping
Voice Groups VoiceGroup
FX Busses EffectBus
Wavetables Wavetable
MIDI Files MidiFile
Data Files DataFile
Scripts Script

Script

Contains the instrument script and displays any parameters declared in the script for editing.

Parameter Description
Bypass Bypass processing of note and controller events by this script.
Script Path Location of script text file on disk.
Script Text of currently active script.
Status Last message printed by the script.

Group

The Instrument can have any number of Group modules. A Group module organizes multiple sample zones and allows for setting trigger conditions and other settings that apply to all samples in the Group. Each Group can contain up to 16 mod sources, 64 mod routings and 16 filters.

Parameter Description
Name Name to display for this Group.
Active When switched off, the Group will not respond to incoming notes.
Volume Volume for all voices in the Group.
Pan Pan (balance if stereo) for all voices in the Group.
Tune Coarse and fine tuning for all voices in the Group.
Tracking Pitch tracking of samples across the keyboard (0% = none, 100% = normal).
Output Select the audio output or Effect Bus to output all Group voices to.
Voice Group Select a Voice Group to control the Group polyphony.
Voices Displays the current number of voices the Group is playing.
Quality Sample playback interpolation mode. Each mode has a different trade-off between CPU load and sound quality. Possible values are:
Eco: Lowest quality and CPU load. Fine for background sounds, or sounds with little high frequency content.
Mid: Middle quality and CPU load. Use instead of Lagrange to increase quality if transposing up a long way.
High: Higher quality and CPU load. Use instead of Sinc 8 to save CPU if transposing up a long way.
Lagrange: Standard 4-point Lagrange interpolation. Good quality for most sounds. Low CPU load.
Hermite: 4-point Hermite interpolation. Similar to Lagrange but sounds smoother at the expense of some aliasing.
Sinc 8: 8-point Sinc interpolation. High quality, but high CPU load especially when transposing up.
Vintage: Emulates a variable rate DAC without an anti-imaging filter (so you might want to add your own lowpass filter tracking the pitch). Low CPU load.
Release Trigger Group should play when a note-off is received rather than a note-on.
Release Timer Used as a mod source for attenuation of release-triggered voices depending on how long the note was held.
Sample Start Adjust the sample start point of all zones in the Group (subject to the zone Start Mod Range setting).
Loop Follows Start Possible values are:
Off: The sample loop set in the Zone is played, unaffected.
On: The sample loop is shifted to the playback start position, which can then be modulated.
Quantized: The loop position is rounded to the nearest multiple of the loop length, so startpoint modulation steps through different sections of the sample for wavetable-style playback. For best results set the sample loop to the last wavetable in the sample and Start Mod Range to maximum.
Quant+Phase: Same as Quantized, but the sample starts playing at a random position within the loop, to avoid unwanted alignment between unison voices.
Mapping Shift This allows the sample mapping to be shifted up or down the keyboard. Usually used in combination with the Tune parameter to transpose the group, compared to just tuning the group which may play samples outside their normal key range.
Alternate Mapping Select an alternative set of sample zones to play, instead of this group’s zones.
De-glitch Start Reduce clicks when the sample startpoint is not at a zero crossing.
Mute Mute the output of this group (unless Solo is on). Does not stop voices in the group from playing.
Solo Solo this group and mute any non-soloed groups. Set to Ignore if soloing other groups should not mute this one.
Conditions Condition*
ModSources ModSource*
ModRoutings ModRouting
Filters Filter*
Zones Zone

Zone

Each Group can contain any number of Zone modules. Each Zone loads and plays one audio file. A Zone with no audio file can still be used to trigger voices that use oscillators to generate their sound.

Parameter Description
Sample Relative path and filename of sample this zone plays.
Status Displays if the sample was Loaded, Not Loaded, or Not Found.
Volume Volume offset.
Pan Pan position offset.
Tune Tuning offset.
Root Key Key that will play the sample at its original pitch.
Low Key Lowest key that will trigger this zone.
High Key Highest key that will trigger this zone.
Low Vel Lowest velocity that will trigger this zone.
High Vel Highest velocity that will trigger this zone.
Low Key Fade Fade out at bottom of key range.
High Key Fade Fade out at top of key range.
Low Vel Fade Fade out at bottom of velocity range.
High Vel Fade Fade out at top of velocity range.
Fade Curve Curve of fades (0 = linear, 100 = equal power).
Start Start point of sample, in frames.
Start Mod Range Startpoint modulation range in frames.
End End point of sample, in frames.
Length Display available length in frames.
Reverse Play the sample in reverse (from End until Start or Loop Start).
Loop Enable looping.
Loop Start Loop start point, in frames.
Loop End Loop end point, in frames (this frame is not included in the loop).
Slice Length Imported from Recycle files or set manually - can be read by instrument script.
Zone Param 1 Per-zone value to use as a modulation source.
Zone Param 2 Per-zone value to use as a modulation source.
Orig Tempo Imported from Apple Loop, Acid or REX files or set manually - read by Timestretch module.
Loop Crossfade Apply a crossfade at the end of the sample loop to smooth the jump back to the loop start.
Crossfade Curve Vary the sample loop crossfade between linear (0%) and equal power (100%) to compensate for the possible level dip when waveforms at the loop start and end are uncorrelated.
Tags Free text field for filtering/grouping the zones in a group or mapping. Multiple tags should be newline separated.

Alternate Condition

Lets you define Round Robins, where each note plays a different group in turn. Note this module is only provided for backwards compatibility and that much more detailed conditions can be set up in the instrument script.

Parameter Description
Position Position of this Group in the cycle of Groups with Alternate trigger conditions (0 = never play).
Next Condition Logic for combining the result of this trigger condition with the next (if any). ‘And’ conditions are evaluated before ‘Or’, so for example: A AND B OR C AND NOT D is evaluated as (A AND B) OR (C AND NOT D).

Controller Condition

Only play the group if a MIDI controller is in the specified range, e.g. only when the Sustain Pedal is down. Note this module is only provided for backwards compatibility and that much more detailed conditions can be set up in the instrument script.

Parameter Description
CC MIDI controller number.
From Lowest controller value that enables this Group.
To Highest controller value that enables this Group.
Next Condition Logic for combining the result of this trigger condition with the next (if any). ‘And’ conditions are evaluated before ‘Or’, so for example: A AND B OR C AND NOT D is evaluated as (A AND B) OR (C AND NOT D).

Keyswitch Condition

Activate different groups depending on which keyswitch MIDI key was last pressed, e.g. for selecting articulations in Orchestral instruments. Note this module is only provided for backwards compatibility and that much more detailed conditions can be set up in the instrument script.

Parameter Description
From Lowest keyswitch key that enables this Group.
To Highest keyswitch key that enables this Group.
Next Condition Logic for combining the result of this trigger condition with the next (if any). ‘And’ conditions are evaluated before ‘Or’, so for example: A AND B OR C AND NOT D is evaluated as (A AND B) OR (C AND NOT D).

Random Condition

Use when you want to alternate between two or more Groups in a random order. Note this module is only provided for backwards compatibility and that much more detailed conditions can be set up in the instrument script.

Parameter Description
Next Condition Logic for combining the result of this trigger condition with the next (if any). ‘And’ conditions are evaluated before ‘Or’, so for example: A AND B OR C AND NOT D is evaluated as (A AND B) OR (C AND NOT D).

ADSR Env

Standard synthesizer envelope, to use as a mod source.

Parameter Description
Name Name to display for this mod source.
ModRoutings ModRouting
Attack Attack time.
Attack Curve -100% (slow to reach final value) to +100% (fast to reach final value).
Hold Hold time at maximum level.
Decay Decay time.
Decay Curve -100% (slow to reach final value) to +100% (fast to reach final value). Typically 75 - 90% for exponential curves.
Sustain Sustain Level.
Release Release time.
Release Curve Typically +90% for exponential fade out, or 0% for linear.
Hold End Level Adjust envelope level reached at end of Hold stage, to use Hold as an additional decay.
Times x10 Increase all envelope times by a factor of ten.
Tempo Sync Adjust all envelope times to track the current tempo. The displayed times are used at 120 BPM.

Custom Env

Customizable multi-point curve, to use as a mod source.

Parameter Description
Name Name to display for this mod source.
ModRoutings ModRouting
Sync Measure envelope stage lengths in seconds or quarternote beats.
Curve Edit the envelope points.

LFO

Low Frequency Oscillator, to use as a mod source.

Parameter Description
Name Name to display for this mod source.
ModRoutings ModRouting
Wave Sine, Triangle, Square, Saw, Random (random steps), Drift (smooth random), Saw Up, Saw Exp (exponential decay).
Rate Duration of 1 cycle of the LFO waveform.
Sync Set Rate units to Hz (cycles per second) or beats (quarternotes per cycle).
Retrigger When Off, all voices will be modulated together in sync. When On, the LFO for each voice starts from the beginning when the note is triggered.
Start Phase This shifts the starting point in the LFO waveform. It is most useful when Retrigger is off and Sync is set to beats: then it adjusts the alignment of the LFO waveform relative to beats on the song timeline.
Unipolar When On, the LFO output varies between 0.0 and 1.0, rather than -1.0 and 1.0.

Step Seq

Step sequence generator, to use as a mod source.

Parameter Description
Name Name to display for this mod source.
ModRoutings ModRouting
Rate Length of each step in beats.
Steps Number of steps to repeat (1 to 32).
Sequence Level for each step.
Retrigger When Off, all voices will be modulated together in sync. When On, the sequence for each voice starts from the beginning when the note is triggered.

Mod Routing

Modulation routing, to modulate a parameter of the module containing the routing by one of the available mod source signals. Each Group can contain up to 64 mod routings.

Parameter Description
Active Switch the modulation routing on and off (an inactive routing still uses a little CPU, so delete any that are no longer needed).
Source Modulation Source. External (MIDI) and Group (e.g. envelope and LFO) sources are available here. Possible values are:
Constant: Constant maximum value
Random: Random bipolar value between -1 and +1
Random +: Random unipolar value between 0 and 1.
Pitch Bend: Incoming MIDI pitch bend.
Aftertouch: Incoming MIDI channel pressure.
MIDI CC: The current value of the specified MIDI controller.
Use MIDI Channel: Use the pitch bend, aftertouch or CC value from the note’s MIDI channel. When off, uses the last value received on any channel.
Key: Keyboard position relative to C3. Value increases by 1.0 per octave. For convenience, Key includes all other pitch modulation such as Pitch Bend when used to modulate a voice effect.
Velocity: Incoming MIDI velocity.
Release Timer: Set on note release based on Group Release Timer setting. value is 1 if note is released immediately, 0.5 if released after half the Timer time, and so on).
Glide: Distance relative to previous key, if Instrument Glide setting is active.
Event Param 0: Value set by script or an envelope follower.
Event Param 1: Value set by script or an envelope follower.
Event Param 2: Value set by script or an envelope follower.
Event Param 3: Value set by script or an envelope follower.
Release Vel: Release velocity (bipolar, zero until note released).
Vel In Zone: Velocity relative to zone velocity range (from -1 to 0).
Zone Param 1: Value read from the Zone being played.
Zone Param 2: Value read from the Zone being played.
CC Selects the MIDI controller to monitor when Source is set to MIDI CC.
Invert Reduce the destination parameter instead of increasing it.
Depth Amount of modulation. (100% pitch modulation = 1 octave).
Smooth Smoothing of parameter changes - useful for MIDI controllers. At the maximum setting the initial value is held forever.
Dest Destination parameter to be modulated (depends on the module the routing is inserted in).
Curve Active Determines if a custom curve is applied to the source value.
Curve Edit the curve points.
Use MIDI Channel For MIDI source, use the last value on the channel that triggered this voice, rather than the last value on any channel.
Freeze In Release Hold the source value so it doesn’t change after the key is released.

Voice Effect: BP6 Filter

2-pole (6 dB/oct roll-off) bandpass filter, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Center frequency.
Resonance Strength of resonant peak at center frequency.

Voice Effect: Comb Filter

Delay line with feedback and damping, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Tune Delay time, displayed as resonant frequency in Hz.
Keytrack Tuning should track playback pitch.
Feedback Feedback from delay output to input. At high settings the delay becomes a tuned resonator.
Damping High cut applied to feedback to make it less harsh.
Stiffness Detunes resonant frequencies away from a harmonic series, similar to stiffness in a vibrating string or rod.
Mix Level of the delay output. Can also be phase inverted for phaser-like canceling.
Mix Mode Set to Post, the Mix parameter adds the delayed signal to the output. Set to Pre, the Mix parameter fades the delay input between the input signal and the feedback signal. This can be useful for switching with the Mix parameter from the input signal to a frozen 100% feedback signal.

Voice Effect: Compressor

Compressor effect for controlling dynamic range and shaping transients.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Start Gain Initial gain when voice starts playing.
Link Sidechain Use same gain reduction across related voices. Possible values are:
Off: Each voice is compressed separately.
Same Key: All voices played on the same key (in any group) are linked.
All Keys: All voices played in the group are linked.
Threshold Audio level above which compression is applied.
Ratio Amount of gain reduction to apply.
Attack Time it takes for gain reduction to increase when the signal level rises.
Release Time it takes for gain reduction to increase when the signal level falls.
Output Adjust the output volume to compensate for any loss in level due to compression.

Voice Effect: Crossfade

Fades between mono or stereo channels in a multi-channel sample.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Crossfade Fade between the first and last channel(s) in the sample.
Equal Power Vary between a linear and equal-power crossfade (turn up if the level dips when fading between channels).
Smooth Smoothing of the Crossfade parameter.
Output Set to stereo if the sample contains stereo pairs of channels rather than individual mono channels.

Voice Effect: Damping Filter

Acoustic damping simulation, applied individually to each voice. More natural sounding than a filter sweep.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency. Can usually be left at a fixed value, or modulated slightly by Key.
Damping 0 to 24 dB/oct damping above cutoff frequency. Usually modulated by an increasing envelope to simulate damping of strings (for example) as the sound decays.

Voice Effect: Downmix

Downmix multi-channel sample to stereo.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Smoothing Smoothing of gain parameter changes.
Smooth Start Smooth from silence at start of the note.
Ch1 L Linear gain factor from sample channel 1 to left output.
Ch1 R Linear gain factor from sample channel 1 to right output.
Ch2 L Linear gain factor from sample channel 2 to left output.
Ch2 R Linear gain factor from sample channel 2 to right output.
Ch3 L Linear gain factor from sample channel 3 to left output.
Ch3 R Linear gain factor from sample channel 3 to right output.
Ch4 L Linear gain factor from sample channel 4 to left output.
Ch4 R Linear gain factor from sample channel 4 to right output.
Ch5 L Linear gain factor from sample channel 5 to left output.
Ch5 R Linear gain factor from sample channel 5 to right output.
Ch6 L Linear gain factor from sample channel 6 to left output.
Ch6 R Linear gain factor from sample channel 6 to right output.
Ch7 L Linear gain factor from sample channel 7 to left output.
Ch7 R Linear gain factor from sample channel 7 to right output.
Ch8 L Linear gain factor from sample channel 8 to left output.
Ch8 R Linear gain factor from sample channel 8 to right output.
To Bus Choose an effect bus to downmix to, instead of downmixing in place.

Voice Effect: Envelope Follower

Outputs a control signal that follows the audio level (and/or a mod source signal) individually for each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Attack How fast the envelope follower should react to the audio signal.
Release How fast the envelope follower signal should drop to zero after the input signal has decreased.
Mode Detect peak or RMS (average) level, or ignore the audio level and only use the level modulation signal routed to Dest.
Range How to convert the level to a mod source value: Linear, or a range in dB.
Dest Destination the value is written to (usable as a mod source and accessible in the instrument script).
Output CC Write the value to the selected MIDI CC, which can be used as a mod source. Note the instrument script does not receive these CC changes because they are happening continuously.
Scaling Scale the measured level by the voice volume, optionally incliuding the group volume fader level.

Voice Effect: EQ Band

Single parametric equalizer band, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Freq Center frequency of the EQ band.
Width Slope of the EQ left and right from the center frequency.
Gain Attenuation/Boost.

Voice Effect: Frequency Shifter

Bode frequency shift (inharmonic shift in Hertz, not pitch) applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Mode Shift frequencies up, down, or left and right channels in opposite directions.
Range Frequency shift in Hertz. Low values result in barber’s pole phasing when Mix is set to 50%.
Keytrack Scale the range to give a consistent sound relative to the note being played.
Depth Linear scaling of shift amount, can also be inverted. Useful as a mod destination.
Feedback Add feedback to add overtones or increase depth of phasing.
Mix Dry/wet mix.

Voice Effect: Gain

Volume control, applied individually to each voice. Can be useful between other per-voice inserts.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Level Adjust the audio level.
Invert Phase Flip the phase of the audio.
Ch1 Trim Adjust level for channel 1 of the voice.
Ch2 Trim Adjust level for channel 2 of the voice, if present.
Ch3 Trim Adjust level for channel 3 of the voice, if present.
Ch4 Trim Adjust level for channel 4 of the voice, if present.
Ch5 Trim Adjust level for channel 5 of the voice, if present.
Ch6 Trim Adjust level for channel 6 of the voice, if present.
Ch7 Trim Adjust level for channel 7 of the voice, if present.
Ch8 Trim Adjust level for channel 8 of the voice, if present.

Voice Effect: Granulate

Cut the audio into overlapping grains and modulate their pitch, position, etc.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Grain Size Size of each grain in milliseconds.
Density Number of overlapping grains (values below 1.0 will result in gaps).
Direction Grains play forwards, reverse, alternating or random direction.
Soft Start Whether to play an initial grain at note-on. Useful when density is low.
Pitch Transpose each grain.
Alt. Pitch Alternating transposition of successive grains.
Random Pitch Random transposition of each grain.
Random Pos Play from random positions in the recent input signal.
Random Pan Random stereo/surround position of each grain.
Random Level Random amplitude of each grain.
Mix Mix betweem input (dry) and granulated (wet) signals.

Voice Effect: HP6 Filter

1-pole (6 dB/oct) highpass filter, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.

Voice Effect: HP12 Filter

2-pole (12 dB/oct) highpass filter, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.

Voice Effect: Ladder Filter

4-pole (24 dB/oct) filter, applied individually to each voice. Simulates a vintage analog filter.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency. Peak is damped when the input signal is loud.
Reso Low Cut Reduce resonance at low frequencies, to control the lowest frequency the filter will self-oscillate.
Mode 6 or 12 dB highpass, 6 dB bandpass, or 6 to 24 dB lowpass.

Voice Effect: Limiter

Safety limiter, applied individually to each voice. Stops the voice audio getting too loud.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Attack Controls how quickly the audio level should be limited.
Release Controls how slowly the limiting is reduced after the audio level has decreased.
Maximize Additional gain to push the audio level up against the 0 dB FS threshold.

Voice Effect: Lo-Fi

Sample rate reduction, applied individually to each voice

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Sample Rate Downsampling rate.
Jitter Random modulation of downsampling rate.
Keytrack Sample rate follows keyboard and other pitch modulation.
Bit Depth Bit reduction.
Bit Bias Offset to adjust the quietest audio that jumps from one bit level to the next.
Slew Rate Limit the change from one sample to the next. Simulates ADPCM/companding converters.
Mix Dry/wet mix.

Voice Effect: LP6 Filter

1 pole (6 dB/oct) lowpass filter, applied individually to each voice. Lowest CPU load of all filters.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.

Voice Effect: LP12 Filter

2 pole (12 dB/oct) lowpass filter, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.

Voice Effect: LP24 Filter

4 pole (24 dB/oct) lowpass filter, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.

Voice Effect: Stereo Matrix

Stereo channel routing matrix, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Mode Set how the channels will be combined. Possible values are:
Mix: Fade each output channel between the left and right input channels.
Pan: Set pan position of each input channel across the output channels.
M-S: Adjust the level of the left (M) and right (S) input channels, then M-S decode them.
L+R: Downmix the sum of the left and right channels to mono.
L-R: Downmix the difference of the left and right channels to mono.
Left Adjust left channel according to Mode.
Right Adjust right channel according to Mode.
Update During Note Respond to parameter changes during note or freeze settings at note-on.

Voice Effect: Mod Shaper

Warp a modulation signal connected to the ‘Input’ mod destination of this module.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Input Add a DC offset to the incoming modulation signal.
Curve Which curve shape to apply.
Output Destination to write the resulting processed signal to.
Input Scale Multiply the incoming modulation signal.

Voice Effect: Mod Waveform

Use the waveform of a sample from a mapping as a mod source. Zone ‘Start Mod Range’ should be set to th full length of the sample so it is loaded fully in RAM. The waveform is output to Event Param 0 (plus the right channel to Event Param 1 if stereo).

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Mapping Which mapping to play a sample from.
Key Which key of the mapping to trigger.
Keytrack Should the waveform play faster higher up the keyboard?
Tempo Track Should the waveform playback speed be linked to tempo?
Start Pos Start position in the waveform.
Speed Playback rate of the waveform.

Voice Effect: MS12 Filter

2-pole (12 dB/oct) filter, applied individually to each voice. Simulates a vintage analog filter.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.
Mode 12 dB lowpass or 12 dB highpass.
Reso Boost Increase the strength of the resonant peak and make the filter sound overdriven. The filter also responds to the input signal level.

Voice Effect: Multi-Mode Filter

General purpose filter with up to 4 poles (24 dB/oct), applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.
Mode 12 dB highpass, 6 dB bandpass, or 6 to 24 dB lowpass.
Peak Limit Limit the level of the resonant peak and make the filter sound overdriven. When off, self-oscillation is also disabled to save CPU.

Voice Effect: Phase Modulator

Modulated delay. Can be used for chorus, flanger, comb filter and other effects.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Delay Base delay time.
Delay Mod How the delay time is modulated. Possible values are:
Lin: Linear modulation.
Log: Logarithmic modulation.
Audio: Modulated by audio signal.
Audiio^2: Modulated by square of audio signal.
Keytrack Should the delay time track the note pitch?
Feedback Audio feedback from delay output to input.
Mix Mix between dry (input) and wet (delayed) signal.
Invert Phase Invert the polarity of the delay output.

Voice Effect: Send

Send to an output or Effect Bus, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Output Select destination output or Effect Bus.
Send Level Volume to send to the destination.
Scaling Optionally scale send level by voice volume (similar to a post-fader send in a mixer).
Output Mod The amount the Output parameter can be offset by modulation. Allows the output bus to be set by note velocity, for example. The offset is calculated when the note starts and won’t change while the note is playing.

Voice Effect: Shaper

Waveshaping with customizable curve, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Drive Amount of Waveshaping - technically the drive of the input signal against the curve.
Curve Drawable transfer curve (x-axis = input level, y-axis = output level).
Oversample Switch on to improve audio quality, especially for high pitched sounds and high drive.

Voice Effect: Shelf EQ

Gentle high or low shelving EQ, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Freq Frequency of the shelf.
Low Gain Attenuation/Boost below the specified frequency.
High Gain Attenuation/Boost above the specified frequency.

Voice Effect: State-Variable Filter

2-pole (12 dB/oct) multi-mode filter, applied individually to each voice. Simulates a vintage analog filter.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency. Peak is damped when the input signal is loud.
Low/High Fade between lowpass and highpass response.
Notch/Peak Set the Low/High parameter to pass through a notch or bandpass response at its midpoint.

Voice Effect: Tail Loop

Create a sample loop live on playback instead of by looping the sample playback position.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Delay Delay before input audio is looped.
Tune Match tuning of loop to the input audio.
Damping Per-key damping to apply progressively once the loop starts.
Damping Slope Overall strength of damping.
Decay Per-key volume decay to apply progressively once the loop starts.
Pitch Mod Allow pitch modulation once the loop is playing, instead of freezing the loop pitch.

Voice Effect: Teleport

Transfer audio between different voices to allow filters to be shared or run in parallel.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Event ID Which internal audio bus to use (there is one for each script event ID). Select ‘Self’ to share audio between voices triggered by the same script event, or select which event parameter to read the event ID number from.
Keep On Bus How much of the signal on the bus (silent if this is the first Teleport module in the instrument) should remain on the bus.
Send To Bus How much of the current voice signal should be added to the bus.
From Bus How much of the bus signal should be added to the current voice signal.
Thru Adjust the level of the current voice signal.
Phase Invert Invert the polarity of the Send or From signals.

Voice Effect: Timestretch

Timestretching, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Speed Playback speed through the zone’s sample.
Keytrack Keep the speed constant when played at different pitches across the keyboard.
Tempo Track Adjust the speed to follow tempo changes.
Smoothing Low values preserve the texture of the original sound, but may sound rough. High values increase the clarity of transients.
Formant Shift Adjust formants to make the sound source seem bigger or smaller. To minimize CPU load leave Formant Shift at 0% and Formant Track at 100%.
Formant Track How much the formants shift to follow the pitch. At zero, formant frequencies are fixed.
End Decay Optionally freeze the spectrum at the end of the sample and decay to silence at the specified rate.
End Damping High frequency damping to apply during the End Decay.
Formant Resolution Adjust how closely formant peaks are followed. Reduce if formant processing sounds too resonant or unnatural.
Formant Strength When no wavetable is selected adjusts the depth of the formants from -100 (flattened spectrum) to +100 (accentuated formants). When a wavetable is selected positive strength values replace the sample’s formants with those from the wavetable, and negative values apply the wavetable formants in addition to those of the sample.
Formant Wavetable Optionally select a wavetable to provide formant spectra instead of processing the original formants of the sample.
Wavetable Pos Select which wave from the wavetable to use.
Level To Pos When enabled the Wavetable Pos parameter adjusts the depth of modulation of wavetable position by audio level.

Voice Effect: Waveshaper

Waveshaping with a selection of preset curves, applied individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Mode Curve to apply to the waveform.
Drive Amount of Waveshaping - technically the drive of the input signal against the curve.
Bias DC offset added to the input signal to adjust the position on the curve.

Voice Effect: Analog Oscillator

Multi-waveform oscillator plus sub, added individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Tune The pitch of the oscillator.
Saw Level of the sawtooth waveform.
Pulse Level of the square/pulse waveform.
Pulse Width Width (duty cycle) of the pulse wave. Square when set to 50%.
Min Width Minimum allowed width for the pulse wave, to avoid the sound getting too thin.
Triangle Level of the triangle waveform.
Sub Level of the square sub-oscillator (1 octave down).
Noise Level of white noise.
DC Blocking Highpass filter to avoid a DC offset, especially when modulating pulse width. Adjust to taste.
Phase Mode Start phase of oscillator waveform for each note: reset to zero, free-running, or random.
Sync Simulate analog sync to another oscillator by resetting the phase periodically.
Output Optionally add the oscillator signal to just the left or right channel.

Voice Effect: FM Oscillator

4-operator FM synthesizer with customizable algorithm and waveforms. Like the original, aliasing is possible so check the consistency of high notes at all sample rates.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Tune The pitch of the oscillator.
HF Damping Progressively reduce operator 2-4 levels above this breakpoint key.
Wavetable Select a wavetable module as a source for the four Wave parameters.
Op1 Switch operator 1 on and off.
Op1 Wave Select waveform (from sine to triangle when no wavetable is selected).
Op1 Level Operator output level (always routed to output).
Op2 Switch operator 2 on and off.
Op2 Ratio Frequency ratio of operator 2 relative to operator 1.
Op2 Wave Select waveform (from sine to triangle when no wavetable is selected).
Op2 Level Operator output level.
Op2 Dest Operator 2 routing (add to the output, or modulate operator 1).
Op3 Switch operator 3 on and off.
Op3 Ratio Frequency ratio of operator 3 relative to operator 1.
Op3 Wave Select waveform (from sine to triangle when no wavetable is selected).
Op3 Level Operator output level.
Op3 Dest Operator 3 routing (add to the output, or modulate operator 1 or 2).
Op4 Switch operator 4 on and off.
Op4 Ratio Frequency ratio of operator 4 relative to operator 1.
Op4 Wave Select waveform (from sine to triangle when no wavetable is selected).
Op4 Feedback Operator feedback amount, for a richer or noisier waveform.
Op4 Level Operator output level.
Op4 Dest Operator 4 routing (add to the output, or modulate operator 1, 2 or 3).
Start Phase Modulate oscillator start phase e.g. to randomize cyclic tone variations.

Voice Effect: Sample Oscillator

Sample playback with optional granular mode, added individually to each voice. Ensure the Start Mod Range of zones to be played is set to the whole length of the sample!

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Mapping Select which mapping in the instrument to play.
Key Shift Offset added to the key played before selecting a sample zone in the mapping.
Tune Adjust playback pitch, in addition to any zone tuning.
Keytrack Pitch follows keyboard and other pitch modulation.
Sample Pos Playback start position in the sample.
Mix Playback volume of the sample.
Grain Mode Enable granular playback.
Grain Size The length of each grain. To make this track the keyboard, add a mod routing from Key with an inverted depth of exactly 7.52575%.
Sample Speed The speed the grains move through the sample.
Tempo Track Adjust Sample Speed to track the tempo (relative to the zone Original Tempo setting if any).
Random Pitch Add random tuning to each grain.
Random Pos Add random sample position to each grain.
De-Glitch Use the sample pitch (calculated from zone root note and tuning) to align grain positions to cycles in the waveform.
Equal Power Fade Increase to smooth grain transitions if audio is noisy/uncorrelated.

Voice Effect: Sine Oscillator

Sine wave oscillator, added individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Tune The pitch of the generated sine wave.
Keytrack Pitch follows keyboard and other pitch modulation.
Mix The volume of the sine wave, or modulation depth if RingMod is active.
Ring Mod Modulate (multiply) the audio signal by the sine wave, or in Hard mode by the polarity of the sine wave.

Voice Effect: Super Oscillator

Multi-saw oscillator plus sub, added individually to each voice.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Oscillators Number of oscillators (1 to 7).
Tune The center pitch of the generated waveforms.
Detune Amount of detuning between the oscillators.
Mix Volume of the sawtooth oscillators.
Sub Volume of the square sub-oscillators (1 octave down).

Voice Effect: Wavetable Oscillator

Arbitrary waveform oscillator, added individually to each voice. Requires one or more Wavetable modules in the instrument.

Parameter Description
Bypass Disable the module.
ModRoutings ModRouting
Tune The pitch of the generated waveform.
Wavetable Select which wavetable to play (from the Wavetable modules in the instrument).
Wave Select a position in the current wavetable from start to end. The position can be modulated.
Index Displays the number of the waveform in the wavetable currently being played.
Smooth Interpolate between the wavetable indexes, crossfading the waves instead switching from one to the next.
Random Phase Add a random amount to the start phase of the waveform - useful when layering multiple voices.
Mix Adjust the level of the wavetable playback.
Output Optionally add the oscillator signal to just the left or right channel.
Warp Mode Type of waveform warping to apply. Possible values are:
-: No Warping
Shape: Waveshaping curve
Clip: Hard Clipping
Flip: Movable polarity flip
Noise: Modulate with white noise
Quantize: Reduce sample rate
Skew: Shift centre of waveform left or right
PWM: Shrink waveform length
Sync: Oscillator sync
Warp Amount of waveform warping.
Audio FM Amount of audio-rate modulation. The modulation source is the first channel (left/mono) of the input audio.

Effect Bus

Each Effect Bus contains a number of effects, and can have audio routed to it by Groups or other Effect Busses. Each Effect Bus can route it’s output signal to an audio output or to another Effect Bus.

Parameter Description
Name Name to display for this Effect Bus.
Volume Output level.
Output Destination output or bus.
Mute Mute the output of this bus (unless Solo is on). Does not stop the effects in the bus from running.
Solo Solo this bus and mute any non-soloed busses. Set to Ignore if soloing other busses should not mute this one.
Effects Effect*

Effect Mod

Automation of an effect parameter from various sources and/or a built-in step LFO.

Parameter Description
Active Switch this modulation routing on or off. Possible values are:
Off:
On:
Source Select a mod source. Possible values are:
Constant: Fixed value.
Pitch Bend: MIDI pitch bend value.
Aftertouch: MIDI channel pressure value.
MIDI CC: MIDI controller value seelcted by the CC parameter.
Env Follower: Uses the output of the previous Envelope Follower effect in the bus.
Prev Mod: Uses the value of the previous effect modulator in the bus, for modulating multiple parameters the same way.
CC When Source is set to MIDI CC, selects which CC number to read from.
Smooth Optional smoothing of the source value.
LFO Activate the step LFO. Possible values are:
Off:
On:
Steps Edit the LFO steps.
Start First step to play (allows switching between a few different waveforms).
Length Number of steps to repeat.
Value range: 1 to 128
Rate Adjust the LFO rate (time per step).
Sync Set the LFO rate in steps per beat rather than steps per second. Possible values are:
per sec:
per beat:
Retrig Restart the LFO after pauses in the bus input audio (unsynced only), and when the reference bar beat changes. Possible values are:
Off:
On:
Randomize Scale each step by a random amount.
Ramp Ramping between LFO steps. 0 % switches from one value to the next. Large steps (1.0 or more) are only ramped when set to 100 %.
Rate Mod How much the selected Source value affects the LFO rate.
Depth Mod How much the selected Source value affects the LFO depth.
Invert Reduce the destination parameter instead of increasing it. Possible values are:
Off:
On:
Depth Amount of modulation from the LFO, or direct from the Source value if the LFO is not active.
Dest Destination parameter to be modulated in the effect.
Curve Active Determines if a custom curve is applied to the source value. Possible values are:
Off:
On:
Curve Edit the curve points.

Bus Effect: Audio Meter

Measure the audio signal to provide a meter output the instrument script can connect a prop_meter to.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Select the type of audio measurement. Possible values are:
Peak Level: Accurate peak level measurement
Correlation: Stereo correlation (and peak level if the connected meter has 2 channels)
Spectrum: Up to 10 octave band levels

Bus Effect: Beat Cutter

Cut up the incoming audio and apply various ‘glitch’ effects.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Grid Rate that the audio is cut into steps/slices. Possible values are:
2:
4:
8:
16:
32:
64:
128:
256:
2T:
4T:
8T:
16T:
32T:
64T:
128T:
Swing Adjust length of even steps relative to odd steps, for a shuffle feel.
Grid Per Beat Number of grid steps that are grouped together to treat as one beat.
Value range: 1 to 8
Beat Mask How each beat can be processed. Consists of 8 digits (beats 1 to 8) which are each a sum of the following values: 1=can gate, 2=can repeat, 4=can repitch or reverse.
Can Gate Probability that each grid step will be gated (enabled/disabled by the Beat Mask).
Gate Length Length of gated steps before they are muted, as a proportion of the step length.
Gate Depth Attenuation when gating is applied.
Gate Filter Filter cutoff applied to gated steps.
Filter Random Random filter cutoff per step.
Can Repeat Probability that each grid step will repeat the audio of the previous step (enabled/disabled by the Beat Mask).
Can Reverse Probability that each grid step will be played in reverse (enabled/disabled by the Beat Mask).
Reverse Offset Delay offset when playing in reverse, to allow reversed transients to be aligned where they are wanted.
Can Repitch Probability that each grid step will be pitched up or down one octave (enabled/disabled by the Beat Mask).
Smooth Crossfade between each grid step to reduce clicks and make transitions smoother.
Mix Dry/wet mix.

Bus Effect: Bus Compressor

Punchy compressor with configurable envelope detection.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Detector LF Highpass filter in sidechain, to reduce response to low frequencies.
Detector HF High frequency boost in sidechain, to increase response to high frequencies.
Detector Att Additional attack smoothing in the envelope detector. For an average rather than peak response, set Att and Rel to the same value around 20 ms. For additional release smoothing and shaping, leave Att at zero and increase Rel.
Detector Rel Additional release smoothing in the envelope detector.
Detector Mode How the envelope detector tracks the signal level. Possible values are:
Punch: Follow envelope below threshold, which increases attack punch as the envelope has further to come back up.
Fast: Normal envelope detection with fast attack and release.
Smooth: Release slows down as signal falls below threshold.
Threshold Audio level above which compression is applied.
Ratio Amount of gain reduction to apply.
Slam Boosts the compression ratio so much that the output gets quieter as the input gets louder. Possible values are:
Off:
On:
Attack Time it takes for gain reduction to increase when the signal level rises.
Release Time it takes for gain reduction to decrease when the signal level falls.
Output Adjust the output volume to compensate for any loss in level due to compression.
Parallel Mix Mixes compressor output with input signal.
Sidechain Optionally use the next effect bus (after the one containing this compressor) as a sidechain input. Possible values are:
Off:
Next Bus:

Bus Effect: Channel Split

Routes the selected audio channels to another Effect Bus or to an audio output.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Output Select an output or another Effect Bus to send to.
Value range: -999 to 999
Send Level Volume of sent signal.
Chan 1 Source Choose a channel on this bus to send to channel 1 of the destination.
Chan 2 Source Choose a channel on this bus to send to channel 2 of the destination.
Chan 3 Source Choose a channel on this bus to send to channel 3 of the destination.
Chan 4 Source Choose a channel on this bus to send to channel 4 of the destination.
Chan 5 Source Choose a channel on this bus to send to channel 5 of the destination.
Chan 6 Source Choose a channel on this bus to send to channel 6 of the destination.
Chan 7 Source Choose a channel on this bus to send to channel 7 of the destination.
Chan 8 Source Choose a channel on this bus to send to channel 8 of the destination.
Mute Source Mute the selected source channels in this bus. This can be used for splitting a multi-channel signal across more than one bus. Possible values are:
Off:
On:

Bus Effect: Chorus

Chorus effect for creating a thicker, fatter, wider sound.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Rate Modulation rate.
Depth Depth of delay (pitch) modulation.
Delay Pre-delay for each voice.
Voices Number of chorus voices.
Value range: 1 to 4
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Damping Attenuate high frequencies.
Modulation LFO Waveform. Possible values are:
Square:
Sine:
Random:
Mix Mix between dry and wet signal (both unaffected at 50% mix).

Bus Effect: Compressor

Compressor effect for controlling dynamic range and shaping transients.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Threshold Audio level above which compression is applied.
Ratio Amount of gain reduction to apply.
Soft Knee Gradual increase in ratio as signal level crosses threshold.
Slam Boosts the compression ratio so much that the output gets quieter as the input gets louder. Possible values are:
Off:
On:
Attack Time it takes for gain reduction to increase when the signal level rises.
Release Time it takes for gain reduction to increase when the signal level falls.
Output Adjust the output volume to compensate for any loss in level due to compression.

Bus Effect: Convolution

Process the incoming audio with an impulse response, to add reverberation or the character of another audio device, acoustic space, or signal chain. If there are missing samples, the module icon is shown red.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Impulse Drop one or more impulse files (.wav or .aif). Mono files will perform one convolution (left+right > mono output). Stereo files will perform two convolutions (left > left, right > right). To convolve left and right separately by the same impulse, use a stereo file containing mono audio. To reduce CPU load, keep impulses as short as possible.
Mode Displays the current mode (Mono, Stereo).
Quality Reduce bandwidth to save CPU - should be set as low as possible without hearing artifacts.
Input Width Reduce to mix the left and right inputs together before convolution.
Pre Delay Initial delay before reverb (it is a good idea to trim any pre-delay from the impulse file).
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Decay Applies a volume ramp (decreasing or increasing) to the impulse to adjust the perceived reverb time.
Select Impulse Switch between the loaded impulses, when more than one.
Value range: 1 to 999
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Size Adjust reverb size by slowing or speeding up playback of the impulse.
Current Impulse display name of currently selected impulse.

Bus Effect: Crossover

Splits the audio into three frequency bands which are output into this and the next two effect busses.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Low Freq Crossover frequency between low and mid bands.
High Freq Crossover frequency between mid and high bands.
Slope Crossover roll-off. Higher values give more separation between the bands. Possible values are:
6 dB/oct:
12 dB/oct:
24 dB/oct:

Bus Effect: Delay

Stereo delay effect with adjustable feedback routing and left/right spread.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Time Delay time.
Sync Sets Time parameter to seconds or quarternote beats. Possible values are:
sec:
beats:
Feedback Feedback from delay output to input to create multiple repeats.
Feedback Mode Sets which channel(s) feedback is taken from. Possible values are:
Stereo:
Cross:
Left:
Right:
Ping Pong:
Ratio Negative values reduce the left channel delay, positive values reduce the right channel delay.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Damping Lowpass filter for progressive damping of each delay repeat.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Input Trim Attenuate wet signal before the effect is applied.
Time Trim Add an offset in samples to the left and right delay times. Useful when the delay is used in a feedback loop with latency.

Bus Effect: Distortion

Stereo distortion/overdrive effect.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Drive Input gain to the distortion.
Mode Type of distortion. Possible values are:
Transistor: Stereo hard clipping.
Tube: Soft clipping with DC bias.
Curve...: Custom waveshaping curve.
Low Cut Highpass filter before distortion.
High Cut Lowpass filter before distortion.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Rectify Degree to which negative signal peaks are converted to positive.
Curve Edit the waveshaping curve.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Oversample Improve quality of high frequency / high drive signals (reduced aliasing).

Bus Effect: Downmix

Downmix multi-channel signal to stereo.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Output Optionally select an audio output or effect bus for the mixdown, leaving the multi-channel signal on this bus unaffected.
Value range: -999 to 999
Gain Volume trim.
Ch1 L Linear gain factor from sample channel 1 to left output.
Ch1 R Linear gain factor from sample channel 1 to right output.
Ch2 L Linear gain factor from sample channel 2 to left output.
Ch2 R Linear gain factor from sample channel 2 to right output.
Ch3 L Linear gain factor from sample channel 3 to left output.
Ch3 R Linear gain factor from sample channel 3 to right output.
Ch4 L Linear gain factor from sample channel 4 to left output.
Ch4 R Linear gain factor from sample channel 4 to right output.
Ch5 L Linear gain factor from sample channel 5 to left output.
Ch5 R Linear gain factor from sample channel 5 to right output.
Ch6 L Linear gain factor from sample channel 6 to left output.
Ch6 R Linear gain factor from sample channel 6 to right output.
Ch7 L Linear gain factor from sample channel 7 to left output.
Ch7 R Linear gain factor from sample channel 7 to right output.
Ch8 L Linear gain factor from sample channel 8 to left output.
Ch8 R Linear gain factor from sample channel 8 to right output.

Bus Effect: Embedded GE Instrument

Allows nesting of instruments/effects within other instruments/effects for modularity.

Parameter Description
Bypass Disable processing. Possible values are:
Off:
On:
EffectMods EffectMod
Share Midi CCs Link MIDI CC values between the parent and embedded instruments for reading and writing modulation. This setting is applied when loading Inst Data - switching it live has no effect.
MIDI In Send MIDI data to the embedded instrument. Each message should be encoded to an integer value: (status « 16) + (data1 « 8) + data2
Inst Data Contents of the .inst file to load.

Bus Effect: Embedded GE Instrument and samples loaded from a .blob file

Allows nesting of instruments/effects within other instruments/effects for modularity. See the Embedded Instrument example in the Gorilla SDK for more info.

Parameter Description
Bypass Disable processing. Possible values are:
Off:
On:
EffectMods EffectMod
MIDI In Send MIDI data to the embedded instrument. Each message should be encoded to an integer value: (status « 16) + (data1 « 8) + data2
Blob Path Full path to the .blob file to load.

Bus Effect: Envelope Follower

Does not modify the audio signal, but instead measures its level to use as a modulation source elsewhere.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Type of envelope detection. Possible values are:
Lin: Linear (voltage) measurement between silence and the specified threshold.
Log: Logarithmic (dB) measurement between the specified threshold and 0 dB (full scale).
Gate: Detect if the signal is above or below the threshold.
Thresh Audio Level (function depends on Mode setting).
Attack Rise time when the audio level increases or the gate opens.
Release Fall time when the audio level decreases or the gate closes.
Output CC Write the envelope level to the selected MIDI CC, which can be used as a mod source. Note the instrument script does not receive these CC changes because they are happening continuously. Possible values are:
-:

Bus Effect: EQ

Four-band equalizer with parametric mid bands.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Low Gain Low frequency boost or cut.
Low Freq Low shelf frequency.
Mid 1 Gain Low-mid frequency boost or cut.
Mid 1 Freq Low-mid center frequency.
Mid 1 Width Low-mid bell bandwidth.
Mid 2 Gain High-mid frequency boost or cut.
Mid 2 Freq High-mid center frequency.
Mid 2 Width High-mid bell bandwidth.
High Gain High frequency boost or cut.
High Freq High shelf frequency.
Output Level trim to compensate for any gain change due to equalization.
Low Contour Shape of low shelf: Baxandall at 0%, values above 50% add a notch.
High Contour Shape of high shelf: Baxandall at 0%, values above 50% add a notch.

Bus Effect: Filter

Filter effect which can be used as an alternative to the per-voice Filter modules in Groups if you want to apply a filter after other effects, or don’t need to modulate the filter independently for each voice.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Type of filter to apply Possible values are:
LP12: 12 dB/oct lowpass.
LP24: 24 dB/oct lowpass.
LP+: Brickwall lowpass (no resonance).
BP6: Bandpass with 6 dB/oct roll-offs.
HP12: 12 dB/oct highpass.
HP+: Brickwall highpass (no resonance).
Comb+: Comb filter.
Comb-: Comb filter with inverted polarity.
SVF: State Variable filter.
Wah: Wah-wah pedal.
LP6: 6 dB/oct lowpass.
HP6: 6 dB/oct highpass.
Cutoff Cutoff frequency.
Resonance Strength of resonant peak at cutoff frequency.
SVF Low/High Fade between lowpass and highpass response in SVF filter mode.
SVF Notch/Peak Fade between notch and bandpass response in SVF filter mode.
Smoothing Limit speed of cutoff changes for a smoother sound.

Bus Effect: Flanger

Flanger effect based on a modulated delay line.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Rate Modulation rate.
Depth Delay modulation depth.
Delay Minimum delay.
Feedback Add resonant peaks.
Phase Phase offset between left and right modulation.
Mix Dry/wet mix.

Bus Effect: Frequency Shifter

Bode frequency shift (inharmonic shift in Hertz, not pitch).

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Shift direction for left and right channels. Possible values are:
Up:
Down:
Up/Down:
Down/Up:
Range Frequency shift in Hertz. Low values result in barber’s pole phasing when Mix is set to 50%.
Depth Linear scaling of shift amount, can also be inverted. Useful as a mod destination.
Feedback Add feedback to add overtones or increase depth of phasing.
Mix Dry/wet mix.
Balance Fade between selected direction (100%) to the opposite direction through ring modulation (0%).

Bus Effect: Gate

Noise gate with duck mode and optional sidechain.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Gate or Duck. Possible values are:
Gate: Attenuate when signal is below threshold.
Duck: Attenuate when signal is above threshold.
Sidechain Trigger input. Possible values are:
Off: No sidechain - use effect input level.
Env Follower: Use envelope follower in effect bus as sidechain input.
Next Bus: Use signal in next effect bus as sidechain input.
Manual Only: Only respond to Manual Trigger parameter.
Manual Trigger Trigger the gate manually or from the instrument script. Possible values are:
Off:
On:
Threshold Adjust the audio level that causes the gate to open.
Range Adjust the attenuation when the gate is closed.
Attack Time the gate takes to open.
Hold Minimum time the gate will stay open for.
Release Time the gate takes to close.

Bus Effect: Grain Pitch

Granular Pitch-Shift and Delay

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Delay Delay time before grains play.
Sync Set the delay time in seconds or quarternote beats. Possible values are:
sec:
beats:
Random Delay Randomize grain position in the delay line (100% = anywhere from zero to delay time).
Feedback Feedback from grain output back to delay input.
Grain Size Grain duration in milliseconds.
Tempo Track Adjust grain size relative to the tempo (120 BPM = no change). Possible values are:
Off:
On:
Random Size Random variation in grain size.
Density Overlap between grains. Set below 1.0 for sparse blips, 2.0 or above for a thicker sound or if alternating between two pitches (uses more CPU).
Snap To Grid Quantizes the next grain to the specified beat grid (and therefore limits the grain density to not more than one per grid). Possible values are:
4:
8:
16:
32:
Off:
4T:
8T:
16T:
Direction Set the grain playback direction. Possible values are:
Forward:
Reverse:
Alt.:
Random:
Pitch Playback speed for each grain, to vary the pitch up to 2 octaves.
De-Glitch Phase-align grains for smoother pitch shifting (disable if not needed to reduce CPU load). Possible values are:
Off:
On:
Alt. Pitch Even grains have this value added to their pitch, odd grains have it subtracted.
Random Pitch Random pitch variation for each grain.
Alt. Pan Alternating pan for each grain. Use with Alt Pitch to tune one side up and the other side down.
Random Pan Random pan for each grain.
Low Cut Highpass filter before output and delay feedback.
Limiter Release time of limiter before output and delay feedback. Set to low values for saturation/distortion.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
High Cut Lowpass filter before output and delay feedback.

Bus Effect: Guitar Amp

Models of three classic guitar amplifiers. Mono output.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Model Select the amp model Possible values are:
F:
V:
M:
M HOT:
Gain Input gain.
Bass Bass tone control.
Mid Mid tone control.
Treble Treble tone control.
Volume Amp volume control.
Output Output level trim.
Mode Optionally process the left or right channel only. Possible values are:
Mono:
Left Only:
Right Only:

Bus Effect: Isolator EQ

DJ-style EQ that can be used to eliminate the low mid or high frequencies.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Low Level of low frequencies.
Mid Level of mid frequencies.
High Level of high frequencies.
Low Freq Crossover frequency between low and mid bands.
High Freq Crossover frequency between mid and high bands.

Bus Effect: Leveller

Level normalizer to stop audio getting too loud or quiet.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Target Wanted output level.
Depth Strength of level correction to apply.
Range Floor level - do not boost if the input is quieter than this.
Speed Response time.

Bus Effect: Limiter

Low-CPU safety limiter to keep levels in check, with a fixed 0 dBFS threshold.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Release Recovery time.
Mode Type of limiting. Possible values are:
Soft: Soft knee.
Hard: Hard knee.
Clip: Hard clipping.
Maximize Enable maximizer mode which boosts and compresses the input to the limiter. Possible values are:
Off:
On:
Drive Maximizer input level (only has an effect when Maximize is On).

Bus Effect: Lo-Fi

Sample rate and bit depth reduction.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Sample Rate Downsampling rate.
Jitter Random modulation of downsampling rate.
Mix Dry/wet mix.
Bit Depth Bit reduction.
Bit Bias Offset to adjust the quietest audio that jumps from one bit level to the next.
Slew Rate Limit the change from one sample to the next. Simulates ADPCM/companding converters.

Bus Effect: Master Filter

Master EQ and high/low filter.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Cutoff Turn left for lowpass, right for highpass. Set to exactly 0.0 to save CPU.
Low Reso Resonance of lowpass filter.
Low Reso Track Adjust resonance at high versus low cutoffs.
High Reso Resonance of highpass filter.
High Reso Track Adjust resonance at high versus low cutoffs.
Low Boost Psycho-acoustic low shelf filter.
Low Freq Adjust the frequency of the low boost.
High Boost Psycho-acoustic high shelf filter.
High Freq Adjust the frequency of the high boost.

Bus Effect: Multi-Band Compressor

Separate compression of low, mid and high frequencies.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Low Drive Low frequency input gain.
Mid Drive Mid frequency input gain.
High Drive High frequency input gain.
Low Out Low frequency output level trim.
Mid Out Mid frequency output level trim.
High Out High frequency output level trim.
Low Attack Low frequency compression onset time.
Mid Attack Mid frequency compression onset time.
High Attack High frequency compression onset time.
Low Release Low frequency compression recovery time.
Mid Release Mid frequency compression recovery time.
High Release High frequency compression recovery time.
Low Freq Crossover frequency between low and mid bands.
High Freq Crossover frequency between mid and high bands.
Slope Crossover roll-off. Higher values give more separation between the bands. Possible values are:
6 dB/oct:
12 dB/oct:
24 dB/oct:
Soft Knee Gradual increase in ratio as signal level crosses threshold.
Overshoot When active, knee is extra hard at minimum setting. Possible values are:
Off:
On:
Upwards Comp Compression ratio to apply to bring up low level audio in each band.
Release Curve Choose between fast-then-slow or slow-then-fast release.

Bus Effect: Multi-Band Distortion

Stereo mix of four distortions each preceded by a multi-mode filter.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Band 1 Switch band 1 on and off. Possible values are:
Off:
On:
1 Curve Select different distortion curves.
Value range: -100 to 100
1 Cutoff Adjust cutoff frequency of pre-distortion filter
1 Resonance Adjust filter resonance (values below 11% result in a notch rather than a peak).
1 Tilt Adjust filter mode from highpass, through notch or bandpass, to highpass.
1 Drive Distortion input drive.
1 Level Distortion output volume.
1 Pan Stereo position of the distorted signal. Also fades the distortion input between the left and right inputs to allow true stereo processing.
Band 2 Switch band 2 on and off. Possible values are:
Off:
On:
2 Curve Select different distortion curves.
Value range: -100 to 100
2 Cutoff Adjust cutoff frequency of pre-distortion filter
2 Resonance Adjust filter resonance (values below 11% result in a notch rather than a peak).
2 Tilt Adjust filter mode from highpass, through notch or bandpass, to highpass.
2 Drive Distortion input drive.
2 Level Distortion output volume.
2 Pan Stereo position of the distorted signal. Also fades the distortion input between the left and right inputs to allow true stereo processing.
Band 3 Switch band 3 on and off. Possible values are:
Off:
On:
3 Curve Select different distortion curves.
Value range: -100 to 100
3 Cutoff Adjust cutoff frequency of pre-distortion filter
3 Resonance Adjust filter resonance (values below 11% result in a notch rather than a peak).
3 Tilt Adjust filter mode from highpass, through notch or bandpass, to highpass.
3 Drive Distortion input drive.
3 Level Distortion output volume.
3 Pan Stereo position of the distorted signal. Also fades the distortion input between the left and right inputs to allow true stereo processing.
Band 4 Switch band 4 on and off. Possible values are:
Off:
On:
4 Curve Select different distortion curves.
Value range: -100 to 100
4 Cutoff Adjust cutoff frequency of pre-distortion filter
4 Resonance Adjust filter resonance (values below 11% result in a notch rather than a peak).
4 Tilt Adjust filter mode from highpass, through notch or bandpass, to highpass.
4 Drive Distortion input drive.
4 Level Distortion output volume.
4 Pan Stereo position of the distorted signal. Also fades the distortion input between the left and right inputs to allow true stereo processing.
Low Bypass Cuts distorted low frequencies and lets dry lows pass through.
High Bypass Cuts distorted high frequencies and lets dry highs pass through.
Mix Dry/wet mix.

Bus Effect: Multi-Tap Delay

Delay effect with up to 16 configurable taps and smoothing of delay time changes.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Time Delay time.
Sync Sets Time parameter to seconds or quarternote beats. Possible values are:
sec:
beats:
Input Width Reduce (or flip for negative values) the stereo width of the delay input and each feedback repeat.
Feedback Feedback to the delay input to create multiple repeats.
Feedback Tap Select which output tap the feedback is taken from.
Value range: 1 to 16
Tap Time Delay time for each tap, as a percentage of the Time parameter.
Tap level Volume for each tap. Set to zero to disable the tap, saving CPU.
Tap Pan Stereo pan position for each tap.
Tap Filter Filter center frequency for each tap. Filters are bypassed at 0% if Resonance is also 0%.
Resonance Filter resonance for all taps. Morphs from a gentle tone control to a narrow bandpass.
Low Cut Highpass filter for progressive thinning of each delay repeat.
High Cut Lowpass filter for progressive damping of each delay repeat.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Saturation Add dirt to the delay/feedback signal.
Chaos Add feedback from all taps back to the input. Depending on tap delay times this can get out of control!
Glide Time Adjust speed of delay time changes and the resulting pitch modulation.

Bus Effect: Non-Linear Reverb

Reverberation with a hard ‘gated’ cutoff after the reverb time.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Time Length of reverb tail before it is cut off.
Low Cut Highpass filter cutoff frequency.
High Cut Lowpass filter cutoff frequency.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Input Trim Attenuate wet signal before the effect is applied.

Bus Effect: Pan

Pan, stereo width and phase adjustment.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Width Adjust stereo width using an M-S matrix (has no effect on mono signals).
Pan Move the right channel left or the left channel right (different to Group panning which does not move the channels but adjusts their relative levels).
Swap Channels Swap left and right inputs. Possible values are:
Off:
On:
Invert Phase Invert the polarity of one or both channels. Possible values are:
Off:
On:
Left Only:
Right Only:
Gain Output level.
Bass Mono Frequency below which stereo width will be reduced to zero.

Bus Effect: Phaser

Phaser effect with up to 8 poles (4 peaks/notches).

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Rate Modulation rate.
Depth Center frequency modulation.
Feedback Add resonant peaks between the notches.
Center Center frequency.
Spread Offset between left and right center frequencies
Mix Dry/wet mix.
Poles Number of stages (more stages = more peaks and notches). Possible values are:
2:
4:
6:
8:
SS: Vintage 4-stage
Invert Feedback Flip feedback polarity for a different sound character. Possible values are:
Off:
On:
LFO Shape Adjust LFO waveform from sine through triangle to parabola.
Feedback Low Cut Reduce feedback build-up at low frequencies.
LFO Phase Phase offset between left and right modulation.
Sync Synchronize the Rate to tempo (so a rate of 2.0 results in two LFO cycles per quarternote.

Bus Effect: Pitch Shifter

Polyphonic pitch shifter with formant preservation/adjustment.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Shift L How many semitones to shift the pitch of the left channel.
Shift R How many semitones to shift the pitch of the right channel.
Link L+R Apply the left shift amount to both left and right channels.
Freeze Freeze the current spectrum.
Range Adjust bandwidth. Lower values also have better frequency resolution for shifting chords more cleanly, but higher latency.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Dry/wet mix.
Formant Shift Adjust formants to make the sound source seem bigger or smaller. To minimize CPU load leave Formant Shift at 0% and Formant Track at 100%.
Formant Track How much the formants shift to follow the pitch shift. At zero, formant frequencies are fixed.
Tuning Correction Amount of correction of detuned notes (relative to the instrument Tune parameter).
Scale Correction 12 semitones starting at C. Set each semitone to 1 if it should be allowed or 0 if it should be avoided.
Correction Speed Speed the tuning and scale corrections are applied to the pitch shifted signal.
Dry Latency Delay the dry signal by the same amount as the processing delay of the wet signal so they are aligned.
Latency Hidden read-only parameter whose value is the current processing delay of the wet signal, measured in sample frames.

Bus Effect: Resonators

Tuned resonators for emulating sympathetic resonance of pianos and other instruments. Fine tuning is controlled by the instrument Tune parameter.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Decay Resonance decay time.
Keytrack Faster decay at higher frequencies.
Width Stereo spread of the individual resonators.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).

Bus Effect: Reverb

Algorithmic reverb emulating a digital reverb unit. For convolution reverb, please use the Convolution module.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Time Length of reverb tail.
Pre Delay Initial delay before reverb.
Low Cut Highpass filter cutoff frequency.
High Cut Lowpass filter cutoff frequency.
Damping Progressive loss of high frequencies in reverb tail.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Low Damping Progressive loss of low frequencies in reverb tail.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Input Trim Attenuate wet signal before the effect is applied.

Bus Effect: Reverb2

Algorithmic reverb with a range of preset rooms/modes. For convolution reverb, please use the Convolution module.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mode Select from a range of room shapes and reverb types. Possible values are:
Basic: A general purpose colourless reverb.
Legacy GE: Sounds the same as the older GE Reverb effect.
Vintage Q: Based on a classic hardware reverb.
Vintage Q Dense: Like Vintage Q but smoother and with a different attack.
Vintage Q Sparse: Like Vintage Q but rougher and lower density.
Vintage E: Based on one of the oldest digital reverbs.
Vintage 80s: Based on a cheap digital reverb.
Vintage 80s II: Like Vintage 80s but with a slower attack contour.
Gated: Reverb that stops abruptly when the Time parameter is low.
Reverse: Reverb that rises in level then stops abruptly.
Plate:
Reso Plate:
Fat Plate:
Room:
Tight Room: A fast, thick reverb.
Dense Room:
Tiled Room: Reflective and resonant.
Chamber:
Dance Studio:
Hall:
Theater:
Grainy:
Grainy 2:
Big Cave: Echoes into the distance.
Subway:
Taj Mahal:
Left To Right: The reverb moves across the stereo image.
Back Row:
Back Of Hall:
Dense Hall:
Wood Hall:
Large Hall:
Stadium:
Sports Hall:
Parking Garage:
Wide:
Diffuse Hall:
Deep Space: Slow and smooth.
ER Drums: Drum Room with prominent early reflections.
ER Chamber:
ER Stage:
ER Opera:
ER Stadium:
Pre Delay Initial delay before reverb.
Time Length of reverb tail.
Size Scale the size of the room.
Low Cut Highpass filter cutoff frequency.
Mid Gain Mid EQ amount.
Mid Freq Mid EQ frequency.
High Cut Lowpass filter cutoff frequency.
Low Freq Frequency used for Low Mult.
Low Mult Increase or decrease reverb time at low frequencies.
High Damp Progressive loss of high frequencies in reverb tail.
Diffusion Amount of blurring/smoothing of relections.
Modulation Pitch modulation within the reverb for a richer sound.
Width Adjust stereo width of the wet signal.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).
Input Trim Attenuate wet signal before the effect is applied.

Bus Effect: Rotary

Simulates a rotary speaker. Does not contain any overdrive distortion or cabinet simulation, so you might want to combine this effect with the Distortion and Convolution effects.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Speed Rotation speed. Possible values are:
Stop:
Slow:
Fast:
Crossover Crossover frequency between Bass and Horn.
Balance Volume balance between Bass and Horn.
Mic Angle The simulated microphone angle towards the simulated rotary speaker cabinet.
Bass Accel Acceleration and deceleration time of the Bass rotor.
Bass Slow Rotation speed of the Bass rotor at ‘Slow’ speed.
Bass Fast Rotation speed of the Bass rotor at ‘Fast’ speed.
Bass Amp Mod Amplitude modulation of the Bass signal.
Horn Accel Acceleration and deceleration time of the Horn.
Horn Slow Rotation speed of the Horn at ‘Slow’ speed.
Horn Fast Rotation speed of the Horn at ‘Fast’ speed.
Horn Amp Mod Amplitude modulation of the Horn signal.
Horn Freq Mod Frequency modulation of the Horn signal.
Mix Mix between dry and wet signal.

Bus Effect: Sample Player

Play background noise loops etc. If there are missing samples, the module icon is shown red.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Samples Drop one or more sample files (.wav or .aif) into this list.
Select Sample Which sample in the list should be played.
Crossfade Fade in and out time when starting, stopping or switching samples.
Volume Adjust volume of playback.
Tune Ajust pitch/speed of playback.
Play Switch sample playback on and off.

Bus Effect: Saturation

Gradual distortion of the signal.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Thresh The audio level at which saturation occurs. Reduce for more distortion without more level.
Drive Increases the input level resulting in more saturation and more level.
Low Drive Increase the distortion of low frequencies.
High Drive Increase the distortion of high frequencies.
Density Adjust the distortion curve from concave to convex.
High Bypass Crossover to allow high frequencies through unprocessed.
Mix Mix between dry and wet signal.

Bus Effect: Send

Sends a copy of the signal to another Effect Bus or to an audio output.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Output Select an output or another Effect Bus to send to.
Value range: -999 to 999
Send Level Volume of sent signal.
Source Chan L Optionally choose a different channel to send to the left channel of the destination.
Value range: 1 to 8
Source Chan R Optionally choose a different channel to send to the right channel of the destination.
Value range: 1 to 8
Mute Source Mute the source channels after sending them. This can be used for splitting a multi-channel signal across more than one bus, which can be useful as most effects only process the first two channels. Possible values are:
Off:
On:

Bus Effect: Sub Bass

Generate a sub-octave signal (like an octave divider pedal).

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Max Freq Maximum input frequency a sub octave will be generated for.
Tone Adjust harmonic content of generated sub octave.
Dry Level of the unprocessed input signal sent to the output.
Wet Level of the effected signal.
Mix Mix between dry and wet signal (both unaffected at 50% mix).

Bus Effect: Surround Pan

Pan one channel of the bus signal onto a different bus or output.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Input Channel Which single channel of audio to use as the panner input.
Pan Pan position from left to right.
Rear Pan position from front to rear.
Gain Level adjustment.
Output Which bus or output to add the panned signal to.
Channel Layout The channel order of the output bus.

Bus Effect: Transient

Accentuate or reduce the level of signal transients, independent of audio level.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Attack Boost or cut the attack transients.
Hold Length of the attack boost/cut.
Solo Listen to transient or sustain part of signal only.

Bus Effect: Tremolo/Pan

Apply tremolo and/or auto-pan effects.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Rate Adjust the modulation rate.
Sync Switch the modulation rate between cycles per second (Hz) or cycles per beat. Possible values are:
Hz:
per beat:
Depth Adjust the amplitude modulation depth.
Symmetry Adjust the ‘on’ time relative to the ‘off’ time.
Attack Adjust the attack length as a percentage of the ‘on’ time.
Attack Curve Adjust the attack curve (slow…linear…fast…S-curve).
Release Adjust the release length as a percentage of the ‘off’ time.
Release Curve Adjust the release curve (slow…linear…fast…S-curve).
Phase Adjust the initial phase of the modulation (relative to beat positions when sync is on).
Spread Adjust the phase of the right channel relative to the left, to add stereo width and create auto-pan effects.

Bus Effect: Vocoder

Apply the spectrum of one sound to another using a filter bank.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Mod Input Modulator input. Possible values are:
Right Channel: Right channel of this bus, using the left as the carrier signal.
Next Bus: Signal from the next effect bus, using this bus as the carrier.
This Bus: Signal from this effect bus, using the next bus as the carrier.
Bands Number of frequency bands in the filter bank. Possible values are:
4:
8:
12:
16:
20:
24:
Low Freq Center frequency of the lowest band.
High Freq Center frequency of the highest band.
Resonance Adjust the width of each band.
Band Shape Resonant bell shape or flat top. Possible values are:
Bell:
Flat:
Smoothing How fast the envelope of the modulator signal is tracked.
Stereo Spread Pan alternate band outputs left and right.
Gain Level trim for vocoded signal.
Mix Output mix between modulator at 0%, vocoded signal at 50% and carrier signal at 100%

Bus Effect: Width

Delay one channel to create a ‘Haas’ widening effect.

Parameter Description
Bypass Disable the effect. Possible values are:
Off:
On:
EffectMods EffectMod
Delay Delay to right channel only.
Trim Level compensation to adjust the stereo balance.
Depth Adjust amount of Delay and Trim, or completely invert left/right depth at -100 %.

Alternate Mapping

Collection of Zones that can be played by any Group, as an alternative to the Group’s own Zones.

Parameter Description
Name Name to display for this Mapping.
Active When switched off, this mapping’s samples will be purged (not preloaded in memory) unless they are used in other Groups or Mappings.
Zones Zone
Tags Free text field for filtering/grouping the mappings in an instrument. Multiple tags should be newline separated.
Comments Free text field for adding a comment about the mapping.

Voice Group

Polyphony management settings. The available voices in a Voice Group are shared between all Groups assigned to that Voice Group. There is always at least one Voice Group called Instrument Voices which sets the overall maximum polyphony of the instrument. If a Group is not assigned to a Voice Group its polyphony is still managed by the Instrument Voices settings.

Parameter Description
Max Voices Maximum number of voices for all Groups assigned to this voice Group.
Per-Key Voices Maximum number of voices on the same note (leave set to ‘-‘ if not needed).
Voices Displays the current number of voices played in this Voice Group.
Voice Stealing Priority mode for stealing voices when Max Voices is exceeded.
Prefer Released Prefer to steal voices that were already released.
Exclusive Group When a voice is triggered, all voices in other Groups with the same Exclusive Group setting in their voice Group will be cut off.
Fade Time Fade-out length for voices that get stolen.

Wavetable

Set of waveforms that can be played by the Wavetable oscillator. The size and number of waveforms in the wavetable can be varied, and they be overwritten by dropping a WAV file. If the WAV file contains metadata specifying the wavetable size (files exported from Serum have this) then the waveforms are read directly from the file. Otherwise the spectrum is measured at equally spaced points along the whole length of the file to create the wavetable.

Parameter Description
Name Name to display for this module.
Waves Waveform/spectrum editor.
Save Changes If the wavetable should be saved when a patch/preset is saved, or only when sessions are saved in the host app, or not at all. The data is then restored when the preset or session is loaded, creating a new Wavetable module if there is not an existing one at the original index.

MIDI File

MIDI sequence, created by dragging a .mid file into the instrument. Can be accessed by the instrument script.

Parameter Description
Name Name to display for this module.
Tracks Displays the number of tracks in the sequence.
Data Displays the MIDI data.
Tags Free text field for filtering/grouping the MIDI files in an instrument. Multiple tags should be newline separated.
Comments Free text field for adding a comment about the MIDI file.

Data File

Array of data, created by dragging a .csv, .json or .nka file into the instrument. Can be accessed by the instrument script. The file should only contain integer values separated by commas and line breaks.

Parameter Description
Name Name to display for this module.
Data List of integer values.
Save Changes If the data should be saved when a patch/preset is saved, or only when sessions are saved in the host app, or not at all. The data is then restored when the preset or session is loaded by searching for a data file with the same name and at least the same size.
Tags Free text field for filtering/grouping the data files in an instrument. Multiple tags should be newline separated.
Comments Free text field for adding a comment about the data file.