reckfellENGINE

AudioEffectLimiter

Adds a soft-clip limiter audio effect to an audio bus.

On this page
class AudioEffectLimiterReckfellSharpInherits AudioEffect

Adds a soft-clip limiter audio effect to an audio bus.

A "limiter" is an audio effect designed to stop audio signals from exceeding a specified volume threshold level, and usually works by decreasing the volume or soft-clipping the audio. Adding one in the Master bus is always recommended to prevent clipping when the volume goes above 0 dB. Soft clipping starts to decrease the peaks a little below the volume threshold level and progressively increases its effect as the input volume increases such that the threshold level is never exceeded. If hard clipping is desired, consider AudioEffectDistortion.ModeEnum.Clip.

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

Constructors1

AudioEffectLimiterConstructor
# AudioEffectLimiter
C#
public AudioEffectLimiter();

Properties4

CeilingDbProperty
# CeilingDb
C#
public float CeilingDb { get; set; }

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

SoftClipDbProperty
# SoftClipDb
C#
public float SoftClipDb { get; set; }

Modifies the volume of the limited waves, in dB. Value can range from 0 to 6.

SoftClipRatioProperty
# SoftClipRatio
C#
public float SoftClipRatio { get; set; }

This property has no effect on the audio. Use AudioEffectHardLimiter instead, as this Limiter effect is deprecated.

ThresholdDbProperty
# ThresholdDb
C#
public float ThresholdDb { get; set; }

The volume threshold level from which the limiter begins to be active, in dB. Value can range from -30 to 0.

Methods8

GetCeilingDbfloat
# GetCeilingDb
C#
public float GetCeilingDb();
Returns float
GetSoftClipDbfloat
# GetSoftClipDb
C#
public float GetSoftClipDb();
Returns float
GetSoftClipRatiofloat
# GetSoftClipRatio
C#
public float GetSoftClipRatio();
Returns float
GetThresholdDbfloat
# GetThresholdDb
C#
public float GetThresholdDb();
Returns float
SetCeilingDbvoid
# SetCeilingDb
C#
public void SetCeilingDb(float ceiling);
Parameters
NameTypeDefault
ceilingfloat—
SetSoftClipDbvoid
# SetSoftClipDb
C#
public void SetSoftClipDb(float softClip);
Parameters
NameTypeDefault
softClipfloat—
SetSoftClipRatiovoid
# SetSoftClipRatio
C#
public void SetSoftClipRatio(float softClip);
Parameters
NameTypeDefault
softClipfloat—
SetThresholdDbvoid
# SetThresholdDb
C#
public void SetThresholdDb(float threshold);
Parameters
NameTypeDefault
thresholdfloat—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.