Class ChorusEffect

Namespace

NAudio.Effects

Assembly

NAudio.Core.dll

Chorus: a short LFO-modulated delay mixed with the dry signal to thicken and detune it. Classic single-LFO design applied to every channel.

public sealed class ChorusEffect : AudioEffect, IAudioEffect, IParameterized

Inheritance

object

AudioEffect

ChorusEffect

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()

Constructors

ChorusEffect()

Creates a chorus with a 50/50 default mix.

public ChorusEffect()

Properties

BaseDelayMs

Centre delay in milliseconds. Default 15 ms.

public float BaseDelayMs { get; set; }

Property Value

float

DepthMs

Modulation depth in milliseconds. Default 8 ms.

public float DepthMs { get; set; }

Property Value

float

Feedback

Feedback amount, 0 to < 1. Default 0.

public float Feedback { 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>

RateHz

Modulation rate in Hz. Default 0.8 Hz.

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

SyncToTempo(double, NoteDivision)

Locks RateHz to a tempo and note division.

public void SyncToTempo(double bpm, NoteDivision division)

Parameters

bpm double

division NoteDivision