Class FlangerFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Sweeps a comb delay for a jet-plane effect.

public sealed record FlangerFilter : IFilter, IEquatable<FlangerFilter>

Inheritance

object

FlangerFilter

Implements

IFilter

IEquatable<FlangerFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NodeLink only.

Constructors

FlangerFilter(float?, float?, float?, float?, float?, FilterTransition?)

Sweeps a comb delay for a jet-plane effect.

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

Parameters

Rate float?

Sweep rate in Hz. 0.0 and the null default (sent as 0) are rejected before the wire, since they leave the filter inactive and the server would accept and remember that.

Depth float?

Sweep depth, 0.0-1.0. 0.0 and the null default (sent as 0) are rejected before the wire, since they leave the filter inactive and the server would accept and remember that.

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 comb. NodeLink ignores it, the server just echoes it back.

Mix float?

Effect loudness, 0.0-1.0. NodeLink ignores it and just echoes it back, null is sent as 0.5.

Transition FilterTransition

NodeLink currently accepts but ignores this transition, the change always snaps instantly.

Remarks

NodeLink only.

Properties

DelayMilliseconds

Base delay of the comb. NodeLink ignores it, the server just echoes it back.

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

Property Value

float?

Depth

Sweep depth, 0.0-1.0. 0.0 and the null default (sent as 0) are rejected before the wire, since they leave the filter inactive and the server would accept and remember that.

[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. NodeLink ignores it and just echoes it back, null is sent as 0.5.

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

Property Value

float?

Rate

Sweep rate in Hz. 0.0 and the null default (sent as 0) are rejected before the wire, since they leave the filter inactive and the server would accept and remember that.

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

Property Value

float?

Transition

NodeLink currently accepts but ignores this transition, the change always snaps instantly.

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

Property Value

FilterTransition