reckfellENGINE

AudioEffectHardLimiter

Adds a limiter audio effect to an audio bus. Prevents audio signals from exceeding a specified volume level.

On this page
class AudioEffectHardLimiterReckfellSharpInherits AudioEffect

Adds a limiter audio effect to an audio bus. Prevents audio signals from exceeding a specified volume level.

A "limiter" disallows audio signals from exceeding a given volume threshold level in dB. Hard limiters predict volume peaks, and will smoothly apply gain reduction when a peak crosses the ceiling threshold level to prevent clipping. It preserves the waveform and prevents it from crossing the ceiling threshold level. Adding one in the Master bus is recommended as a safety measure to prevent sudden volume peaks from occurring, and to prevent distortion caused by clipping, when the volume exceeds 0 dB. If clipping is desired, consider AudioEffectDistortion.ModeEnum.Clip.

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

Constructors1

AudioEffectHardLimiterConstructor
# AudioEffectHardLimiter
C#
public AudioEffectHardLimiter();

Properties3

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

The waveform's maximum allowed value, in dB. This value can range from -24 to 0. The default value of -0.3 prevents potential inter-sample peaks (ISP) from crossing over 0 dB, which can cause slight distortion on some older hardware.

PreGainDbProperty
# PreGainDb
C#
public float PreGainDb { get; set; }

Gain before limiting, in dB. Value can range from -24 to 24.

ReleaseProperty
# Release
C#
public float Release { get; set; }

Time it takes in seconds for the gain reduction to fully release. Value can range from 0.01 to 3.

Methods6

GetCeilingDbfloat
# GetCeilingDb
C#
public float GetCeilingDb();
Returns float
GetPreGainDbfloat
# GetPreGainDb
C#
public float GetPreGainDb();
Returns float
GetReleasefloat
# GetRelease
C#
public float GetRelease();
Returns float
SetCeilingDbvoid
# SetCeilingDb
C#
public void SetCeilingDb(float ceiling);
Parameters
NameTypeDefault
ceilingfloat—
SetPreGainDbvoid
# SetPreGainDb
C#
public void SetPreGainDb(float preGain);
Parameters
NameTypeDefault
preGainfloat—
SetReleasevoid
# SetRelease
C#
public void SetRelease(float release);
Parameters
NameTypeDefault
releasefloat—
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.