Class TremoloFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Quickly oscillates the volume.

public sealed record TremoloFilter : IFilter, IEquatable<TremoloFilter>

Inheritance

object

TremoloFilter

Implements

IFilter

IEquatable<TremoloFilter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Defaults on Lavalink, frequency 2.0, depth 0.5.

NodeLink reads a missing member as 0 and runs the filter inert, a partial object from a co-client stays inactive there, and a full-chain write by this side fills the unset members with the defaults above, activating it. Send explicit values to pin the sound you intend.

Constructors

TremoloFilter(float?, float?, FilterTransition?)

Quickly oscillates the volume.

public TremoloFilter(float? Frequency = null, float? Depth = null, FilterTransition? Transition = null)

Parameters

Frequency float?

Hz, greater than 0.

Depth float?

Greater than 0 and up to 1.0, Lavalink rejects a larger value, NodeLink clamps it.

Transition FilterTransition

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

Remarks

Defaults on Lavalink, frequency 2.0, depth 0.5.

NodeLink reads a missing member as 0 and runs the filter inert, a partial object from a co-client stays inactive there, and a full-chain write by this side fills the unset members with the defaults above, activating it. Send explicit values to pin the sound you intend.

Properties

Depth

Greater than 0 and up to 1.0, Lavalink rejects a larger value, NodeLink clamps it.

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

Property Value

float?

Frequency

Hz, greater than 0.

[JsonPropertyName("frequency")]
public float? Frequency { get; init; }

Property Value

float?

Transition

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

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

Property Value

FilterTransition