skip to content

Saturator

A saturation/distortion effect with multiple modes, attenuation through a dedicated gain, and two filters for cutting any unwanted low and high frequencies.

class
Saturator
extends
Box
tag
<saturator-blam>
see

Props

name type default description
amount number 50

The amount of saturation applied. Beware that very low numbers result in a drop in overall volume. Adjust the wet and dry signals to mix distortion with the incoming sound.
mode number 1

The type of waveshaping algorithm applied. At the time of writing, 4 modes are offered. Check the source file for more. They formulas appear in the makeCurve() function.
lowcut number 100

A highpass filter for removing any “booming” frequencies produced by applying the saturation.
highcut number 20000

A lowpass filter for taking out harsher frequencies from the high end.
gain number 0.1

For attenuation purposes. Set very low by default, since the saturation adds a lot of its own gain. In testing, 0.1 seems to be just over unity gain.
mix number 0

How much wet, versus dry, signal should come through. In most cases, this is a proportion of 1. If mix is set to 0.75, 75% of the signal will be wet and 25% dry.
bypass boolean false

Whether to send just the dry signal. If set, the dry signal is sent using the wet signal’s gain value, for parity.

Examples

Examples that use the Saturator element: