Class PhaserFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Sweeps a notch through the spectrum for a whooshing effect.

public sealed record PhaserFilter : IFilter, IEquatable<PhaserFilter>

Inheritance

object

PhaserFilter

Implements

IFilter

IEquatable<PhaserFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NodeLink only.

Constructors

PhaserFilter(float?, float?, float?, float?, float?, int?, float?, float?, FilterTransition?)

Sweeps a notch through the spectrum for a whooshing effect.

public PhaserFilter(float? Rate = null, float? Depth = null, float? Feedback = null, float? DelayMilliseconds = null, float? Mix = null, int? Stages = null, float? MinFrequency = null, float? MaxFrequency = null, FilterTransition? Transition = null)

Parameters

Rate float?

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

Depth float?

Sweep depth, 0.0-1.0. 0.0 is rejected, null is sent as the active 1.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, null is sent as 0.

DelayMilliseconds float?

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

Mix float?

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

Stages int?

Number of all-pass stages. The server clamps out-of-range values and treats 0 as its default. Fractional values are rounded on read, NodeLink echoes the raw request back unrounded, null is sent as 4.

MinFrequency float?

Lower bound of the pass, in Hz. Zero falls back to the server default, null is sent as 100.

MaxFrequency float?

Upper bound of the pass, in Hz. Zero falls back to the server default, null is sent as 2500.

Transition FilterTransition

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

Remarks

NodeLink only.

Properties

DelayMilliseconds

Base delay of the pass. 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 is rejected, null is sent as the active 1.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, null is sent as 0.

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

Property Value

float?

MaxFrequency

Upper bound of the pass, in Hz. Zero falls back to the server default, null is sent as 2500.

[JsonPropertyName("maxFrequency")]
public float? MaxFrequency { get; init; }

Property Value

float?

MinFrequency

Lower bound of the pass, in Hz. Zero falls back to the server default, null is sent as 100.

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

Sweep 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?

Stages

Number of all-pass stages. The server clamps out-of-range values and treats 0 as its default. Fractional values are rounded on read, NodeLink echoes the raw request back unrounded, null is sent as 4.

[JsonPropertyName("stages")]
[JsonConverter(typeof(RoundedInt32Converter))]
public int? Stages { get; init; }

Property Value

int?

Transition

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

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

Property Value

FilterTransition