Class DeEsserEffect

Namespace

NAudio.Effects

Assembly

NAudio.Core.dll

Split-band de-esser. A Linkwitz–Riley crossover separates the sibilant high band, which is compressed when it exceeds the threshold; the low band passes through untouched and the two are recombined. More transparent than wideband ducking because only the harsh band is attenuated. Detection is channel-linked.

public sealed class DeEsserEffect : AudioEffect, IAudioEffect, IParameterized

Inheritance

object

AudioEffect

DeEsserEffect

Implements

IAudioEffect

IParameterized

Inherited Members

AudioEffect.Mix

AudioEffect.Bypass

AudioEffect.LatencySamples

AudioEffect.Configure(WaveFormat)

AudioEffect.Process(Span<float>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AttackMs

Attack time in milliseconds. Default 1 ms.

public float AttackMs { get; set; }

Property Value

float

CrossoverFrequency

Crossover frequency separating the sibilant band, in Hz. Default 6000.

public float CrossoverFrequency { get; set; }

Property Value

float

GainReductionDb

The most recent sibilant-band gain reduction in dB (≥ 0), for metering.

public float GainReductionDb { get; }

Property Value

float

Parameters

Generic parameter list (excludes Bypass/Mix, which are on the base).

public IReadOnlyList<EffectParameter> Parameters { get; }

Property Value

IReadOnlyList<EffectParameter>

Ratio

Compression ratio applied to the sibilant band (≥ 1). Default 4.

public float Ratio { get; set; }

Property Value

float

ReleaseMs

Release time in milliseconds. Default 60 ms.

public float ReleaseMs { get; set; }

Property Value

float

ThresholdDb

Sibilant-band threshold in dBFS. Default -30 dB.

public float ThresholdDb { get; set; }

Property Value

float

Methods

OnConfigure(WaveFormat)

Called by Configure(WaveFormat) after the format is stored. Derived effects allocate and size their sample-rate-dependent state here.

protected override void OnConfigure(WaveFormat format)

Parameters

format WaveFormat

ProcessBlock(Span<float>)

Transforms buffer in place into the fully-wet signal. The base class handles dry/wet mixing and bypass around this call.

protected override void ProcessBlock(Span<float> buffer)

Parameters

buffer Span<float>

Reset()

Clears internal state (delay lines, envelopes, smoothers) so the next block starts as if from silence.

public override void Reset()