Class TimescaleFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Changes speed, pitch and rate.

public sealed record TimescaleFilter : IFilter, IEquatable<TimescaleFilter>

Inheritance

object

TimescaleFilter

Implements

IFilter

IEquatable<TimescaleFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Server defaults, 1.0 (no change).

The NodeLink-only transition fades the filter in or out, parameter changes animate towards the new values. During the transition the position estimate advances step-wise at the target pace, it does not interpolate the ramp.

Constructors

TimescaleFilter(double?, double?, double?, FilterTransition?)

Changes speed, pitch and rate.

public TimescaleFilter(double? Speed = null, double? Pitch = null, double? Rate = null, FilterTransition? Transition = null)

Parameters

Speed double?

Speed multiplier, greater than 0, the server default is 1.0 (no change).

Pitch double?

Pitch multiplier, greater than 0, the server default is 1.0 (no change).

Rate double?

Rate multiplier, greater than 0, the server default is 1.0 (no change).

Transition FilterTransition

Fades the filter in or out instead of stepping, NodeLink only. Parameter changes animate towards the new values too.

Remarks

Server defaults, 1.0 (no change).

The NodeLink-only transition fades the filter in or out, parameter changes animate towards the new values. During the transition the position estimate advances step-wise at the target pace, it does not interpolate the ramp.

Properties

Pitch

Pitch multiplier, greater than 0, the server default is 1.0 (no change).

[JsonPropertyName("pitch")]
public double? Pitch { get; init; }

Property Value

double?

Rate

Rate multiplier, greater than 0, the server default is 1.0 (no change).

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

Property Value

double?

Speed

Speed multiplier, greater than 0, the server default is 1.0 (no change).

[JsonPropertyName("speed")]
public double? Speed { get; init; }

Property Value

double?

Transition

Fades the filter in or out instead of stepping, NodeLink only. Parameter changes animate towards the new values too.

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

Property Value

FilterTransition