Class VibratoFilter

Namespace

Nyra.Entities.Filters

Assembly

Nyra.dll

Quickly oscillates the pitch.

public sealed record VibratoFilter : IFilter, IEquatable<VibratoFilter>

Inheritance

object

VibratoFilter

Implements

IFilter

IEquatable<VibratoFilter>

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

VibratoFilter(float?, float?, FilterTransition?)

Quickly oscillates the pitch.

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

Parameters

Frequency float?

Hz, greater than 0, up to 14.0 on Lavalink (NodeLink imposes no ceiling).

Depth float?

Greater than 0, up to 1.0 on Lavalink, NodeLink clamps larger values.

Transition FilterTransition

Fades the filter in or out instead of stepping, NodeLink only. Parameter changes still step, only the equalizer, timescale, channel mix, low-pass and high-pass animate parameter changes.

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, up to 1.0 on Lavalink, NodeLink clamps larger values.

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

Property Value

float?

Frequency

Hz, greater than 0, up to 14.0 on Lavalink (NodeLink imposes no ceiling).

[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, only the equalizer, timescale, channel mix, low-pass and high-pass animate parameter changes.

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

Property Value

FilterTransition