Table of Contents

Class AudioEffectLimiter

Namespace
Godot
Assembly
GodotSharp.dll

A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master bus is always recommended to reduce the effects of clipping.

Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.

public class AudioEffectLimiter : AudioEffect, IDisposable
Inheritance
AudioEffectLimiter
Implements
Inherited Members

Constructors

AudioEffectLimiter() 

public AudioEffectLimiter()

Properties

CeilingDb

The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.

public float CeilingDb { get; set; }

Property Value

float

SoftClipDb

Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.

public float SoftClipDb { get; set; }

Property Value

float

SoftClipRatio 

public float SoftClipRatio { get; set; }

Property Value

float

ThresholdDb

Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

public float ThresholdDb { get; set; }

Property Value

float

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page