AudioEffectDistortion

Adds a distortion audio effect to an audio bus. Remaps audio samples using a nonlinear function to achieve a distorted sound.

A "distortion" effect modifies the waveform via a nonlinear mathematical function (see available ones in AudioEffectDistortion.ModeEnum), based on the amplitude of the waveform's samples. Note: In a nonlinear function, an input sample at x amplitude value, will either have its amplitude increased or decreased to a y value, based on the function value at x, which is why even at the same AudioEffectDistortion.Drive, the output sound will vary depending on the input's volume. To change the volume while maintaining the output waveform, use AudioEffectDistortion.PostGain. In this effect, each type is a different nonlinear function. The different types available are: clip, atan, lofi (bitcrush), overdrive, and waveshape. Every distortion type available here is symmetric: negative amplitude values are affected the same way as positive ones. Although distortion will always change frequency content, usually by introducing high harmonics, different distortion types offer a range of sound qualities; from "soft" and "warm", to "crunchy" and "abrasive". For games, it can help simulate sound coming from some saturated device or speaker very efficiently. It can also help the audio stand out in a mix, by introducing higher frequencies and increasing the volume. Note: Although usually imperceptible, an enabled distortion effect still changes the sound even when AudioEffectDistortion.Drive is set to 0. This is not a bug. If this behavior is undesirable, consider disabling the effect using AudioServer.SetBusEffectEnabled.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public AudioEffectDistortion();

public float Drive { get; set; }

public float KeepHfHz { get; set; }

public AudioEffectDistortion.ModeEnum Mode { get; set; }

public float PostGain { get; set; }

public float PreGain { get; set; }

public float GetDrive();

public float GetKeepHfHz();

public AudioEffectDistortion.ModeEnum GetMode();

public float GetPostGain();

public float GetPreGain();

public void SetDrive(float drive);

public void SetKeepHfHz(float keepHfHz);

public void SetMode(AudioEffectDistortion.ModeEnum mode);

public void SetPostGain(float postGain);

public void SetPreGain(float preGain);