Class HighPassFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Suppresses lower frequencies, the counterpart of the low-pass filter.

public sealed record HighPassFilter : IFilter, IEquatable<HighPassFilter>

Inheritance

object

HighPassFilter

Implements

IFilter

IEquatable<HighPassFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NodeLink only.

Constructors

HighPassFilter(float?, float?, FilterTransition?)

Suppresses lower frequencies, the counterpart of the low-pass filter.

public HighPassFilter(float? Smoothing = null, float? TargetAlpha = null, FilterTransition? Transition = null)

Parameters

Smoothing float?

Smoothing factor, the server default is 0, and any value of 0 to 1.0 leaves the filter inactive. Negative values are rejected client-side before the wire. Higher smoothing cuts more audio.

TargetAlpha float?

Direct coefficient override in the settings schema, but NodeLink ignores it (the coefficient comes from the smoothing), the server just echoes it back.

Transition FilterTransition

Fades the filter in or out instead of stepping. A smoothing change sent with a transition animates towards the new coefficient too, like the low-pass counterpart.

Remarks

NodeLink only.

Properties

Smoothing

Smoothing factor, the server default is 0, and any value of 0 to 1.0 leaves the filter inactive. Negative values are rejected client-side before the wire. Higher smoothing cuts more audio.

[JsonPropertyName("smoothing")]
public float? Smoothing { get; init; }

Property Value

float?

TargetAlpha

Direct coefficient override in the settings schema, but NodeLink ignores it (the coefficient comes from the smoothing), the server just echoes it back.

[JsonPropertyName("targetAlpha")]
public float? TargetAlpha { get; init; }

Property Value

float?

Transition

Fades the filter in or out instead of stepping. A smoothing change sent with a transition animates towards the new coefficient too, like the low-pass counterpart.

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

Property Value

FilterTransition