Class ChorusFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Layers slightly delayed copies for a thickening effect.

public sealed record ChorusFilter : IFilter, IEquatable<ChorusFilter>

Inheritance

object

ChorusFilter

Implements

IFilter

IEquatable<ChorusFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NodeLink only.

Constructors

ChorusFilter(float?, float?, float?, float?, float?, FilterTransition?)

Layers slightly delayed copies for a thickening effect.

public ChorusFilter(float? Rate = null, float? Depth = null, float? Feedback = null, float? DelayMilliseconds = null, float? Mix = null, FilterTransition? Transition = null)

Parameters

Rate float?

Modulation rate in Hz. 0.0 leaves the filter inactive and is rejected, and so is the null default (sent as 0).

Depth float?

Modulation depth, 0.0-1.0. 0.0 leaves the filter inactive and is rejected, and so is the null default (sent as 0).

Feedback float?

How much of the output is fed back in, 0.0-1.0. The server clamps out-of-range values and echoes the request back unclamped.

DelayMilliseconds float?

Base delay of the copies, null is sent as 25. The server clamps out-of-range values and reads an explicit 0.0 as the null default.

Mix float?

Effect loudness, 0.0-1.0. 0.0 is rejected, null is sent as the active 0.5.

Transition FilterTransition

Fades the filter in or out instead of stepping. Parameter changes still step.

Remarks

NodeLink only.

Properties

DelayMilliseconds

Base delay of the copies, null is sent as 25. The server clamps out-of-range values and reads an explicit 0.0 as the null default.

[JsonPropertyName("delay")]
public float? DelayMilliseconds { get; init; }

Property Value

float?

Depth

Modulation depth, 0.0-1.0. 0.0 leaves the filter inactive and is rejected, and so is the null default (sent as 0).

[JsonPropertyName("depth")]
public float? Depth { get; init; }

Property Value

float?

Feedback

How much of the output is fed back in, 0.0-1.0. The server clamps out-of-range values and echoes the request back unclamped.

[JsonPropertyName("feedback")]
public float? Feedback { get; init; }

Property Value

float?

Mix

Effect loudness, 0.0-1.0. 0.0 is rejected, null is sent as the active 0.5.

[JsonPropertyName("mix")]
public float? Mix { get; init; }

Property Value

float?

Rate

Modulation rate in Hz. 0.0 leaves the filter inactive and is rejected, and so is the null default (sent as 0).

[JsonPropertyName("rate")]
public float? Rate { get; init; }

Property Value

float?

Transition

Fades the filter in or out instead of stepping. Parameter changes still step.

[JsonPropertyName("transition")]
public FilterTransition? Transition { get; init; }

Property Value

FilterTransition