AudioEffectDistortion

Inherits: AudioEffect < Resource < RefCounted < Object

Adds a distortion audio effect to an Audio bus.

Modify the sound to make it distorted.

Description

Different types are available: clip, tan, lo-fi (bit crushing), overdrive, or waveshape.

By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.

Tutorials

Properties

float

drive

0.0

float

keep_hf_hz

16000.0

Mode

mode

0

float

post_gain

0.0

float

pre_gain

0.0

Enumerations

enum Mode:

  • MODE_CLIP = 0 --- Digital distortion effect which cuts off peaks at the top and bottom of the waveform.

  • MODE_ATAN = 1

  • MODE_LOFI = 2 --- Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices.

  • MODE_OVERDRIVE = 3 --- Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers.

  • MODE_WAVESHAPE = 4 --- Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.

Property Descriptions

Default

0.0

Setter

set_drive(value)

Getter

get_drive()

Distortion power. Value can range from 0 to 1.


Default

16000.0

Setter

set_keep_hf_hz(value)

Getter

get_keep_hf_hz()

High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.


Default

0

Setter

set_mode(value)

Getter

get_mode()

Distortion type.


Default

0.0

Setter

set_post_gain(value)

Getter

get_post_gain()

Increases or decreases the volume after the effect. Value can range from -80 to 24.


Default

0.0

Setter

set_pre_gain(value)

Getter

get_pre_gain()

Increases or decreases the volume before the effect. Value can range from -60 to 60.