Table of Contents

Class EchoFilter

Namespace
Nyra.Entities.Filters
Assembly
Nyra.dll

Repeats the audio after a delay.

public sealed record EchoFilter : IFilter, IEquatable<EchoFilter>
Inheritance
EchoFilter
Implements
Inherited Members

Remarks

NodeLink only. An instance with every member null is rejected, the delay and mix both read as their rejected 0.0 neutral.

Constructors

EchoFilter(float?, float?, float?, FilterTransition?)

Repeats the audio after a delay.

public EchoFilter(float? DelayMilliseconds = null, float? Feedback = null, float? Mix = null, FilterTransition? Transition = null)

Parameters

DelayMilliseconds float?

Echo delay in milliseconds, greater than 0 (null is sent as 0 and rejected). The server clamps values above its maximum.

Feedback float?

How much of the echo is fed back in, 0.0-1.0.

Mix float?

Echo loudness, 0.0-1.0. 0.0 leaves the block inactive and is rejected, and so is null (sent as 0).

Transition FilterTransition

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

Remarks

NodeLink only. An instance with every member null is rejected, the delay and mix both read as their rejected 0.0 neutral.

Properties

DelayMilliseconds

Echo delay in milliseconds, greater than 0 (null is sent as 0 and rejected). The server clamps values above its maximum.

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

Property Value

float?

Feedback

How much of the echo is fed back in, 0.0-1.0.

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

Property Value

float?

Mix

Echo loudness, 0.0-1.0. 0.0 leaves the block inactive and is rejected, and so is null (sent as 0).

[JsonPropertyName("mix")]
public float? Mix { 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