Class ComfortNoiseEffect

Namespace

NAudio.Effects

Assembly

NAudio.Core.dll

Adds a low level of gently shaped (low-passed) noise. Typically placed after a gate or noise suppressor so processed silence is not unnaturally "dead" — a small comfort-noise floor keeps the channel sounding live. Deterministic generator.

public sealed class ComfortNoiseEffect : AudioEffect, IAudioEffect, IParameterized

Inheritance

object

AudioEffect

ComfortNoiseEffect

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

LevelDb

Noise level in dBFS. Default -60 dB.

public float LevelDb { get; set; }

Property Value

float

Parameters

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

public IReadOnlyList<EffectParameter> Parameters { get; }

Property Value

IReadOnlyList<EffectParameter>

Tone

Tone shaping, 0 (full-band/bright) to 1 (heavily low-passed/dark). Default 0.6.

public float Tone { 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()