Class SpatialFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Places the audio at a point in space around the listener, NodeLink only.

public sealed record SpatialFilter : IFilter, IEquatable<SpatialFilter>

Inheritance

object

SpatialFilter

Implements

IFilter

IEquatable<SpatialFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

NodeLink ignores the three position members, they only round-trip through the API. An instance with every member null runs inert, the depth reads as 0, send explicit values to pin the sound you intend.

Constructors

SpatialFilter(float?, float?, float?, float?, float?, FilterTransition?)

Places the audio at a point in space around the listener, NodeLink only.

public SpatialFilter(float? X = null, float? Y = null, float? Z = null, float? Depth = null, float? Rate = null, FilterTransition? Transition = null)

Parameters

X float?

Left-right position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

Y float?

Front-back position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

Z float?

Height position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

Depth float?

Distance feel, 0.0-1.0. 0.0 leaves the filter inactive, and so does null (sent as 0).

Rate float?

Rotation rate in Hz.

Transition FilterTransition

Fades the filter in instead of stepping, and so do removals, no removal in this library carries a transition, a zero depth cuts at once, the transition only fades the blend in. Parameter changes still step.

Remarks

NodeLink ignores the three position members, they only round-trip through the API. An instance with every member null runs inert, the depth reads as 0, send explicit values to pin the sound you intend.

Properties

Depth

Distance feel, 0.0-1.0. 0.0 leaves the filter inactive, and so does null (sent as 0).

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

Property Value

float?

Rate

Rotation rate in Hz.

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

Property Value

float?

Transition

Fades the filter in instead of stepping, and so do removals, no removal in this library carries a transition, a zero depth cuts at once, the transition only fades the blend in. Parameter changes still step.

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

Property Value

FilterTransition

X

Left-right position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

[JsonPropertyName("x")]
public float? X { get; init; }

Property Value

float?

Y

Front-back position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

[JsonPropertyName("y")]
public float? Y { get; init; }

Property Value

float?

Z

Height position, -1.0 to 1.0. NodeLink ignores it, the server just echoes it back.

[JsonPropertyName("z")]
public float? Z { get; init; }

Property Value

float?