AudioEffectLimiter

Adds a soft clip Limiter audio effect to an Audio bus.

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.

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Functions

getCeilingDb
double getCeilingDb()
getSoftClipDb
double getSoftClipDb()
getSoftClipRatio
double getSoftClipRatio()
getThresholdDb
double getThresholdDb()
opAssign
AudioEffectLimiter opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(AudioEffectLimiter other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setCeilingDb
void setCeilingDb(double ceiling)
setSoftClipDb
void setSoftClipDb(double soft_clip)
setSoftClipRatio
void setSoftClipRatio(double soft_clip)
setThresholdDb
void setThresholdDb(double threshold)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

ceilingDb
double ceilingDb [@property getter]
double ceilingDb [@property setter]

The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: -0.1dB.

softClipDb
double softClipDb [@property setter]

Applies a gain to the limited waves. Value can range from 0 to 6. Default value: 2dB.

softClipDb
double softClipDb [@property getter]

Applies a gain to the limited waves. Value can range from 0 to 6. Default value: 2dB.

softClipRatio
double softClipRatio [@property getter]
double softClipRatio [@property setter]
thresholdDb
double thresholdDb [@property getter]
double thresholdDb [@property setter]

Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: 0dB.

Static functions

_new
AudioEffectLimiter _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta