Class TrackStuckEventArgs

Namespace

Nyra.EventArgs

Assembly

Nyra.dll

The current track got stuck.

public sealed class TrackStuckEventArgs : EventArgs

Inheritance

object

EventArgs

TrackStuckEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

GuildId

The guild the player plays in.

[JsonPropertyName("guildId")]
[JsonInclude]
[JsonConverter(typeof(TolerantSnowflakeConverter))]
public ulong GuildId { get; }

Property Value

ulong

Remarks

A frame without the member reads as 0, which matches no connection, the event is dropped. A JSON null reads as 0 the same way, one hostile frame must not kill the event or the frame.

Reason

What the node reported as the cause, NodeLink only, null on Lavalink.

[JsonPropertyName("reason")]
[JsonInclude]
public string? Reason { get; }

Property Value

string

ThresholdMilliseconds

The stuck threshold, in milliseconds, that was exceeded.

[JsonPropertyName("thresholdMs")]
[JsonInclude]
[JsonConverter(typeof(RoundedInt64Converter))]
public long? ThresholdMilliseconds { get; }

Property Value

long?

Remarks

Null when the frame carried none or sent an explicit null. Fractional values are rounded, a value that is not a number at all drops the event whole, and so does a number outside the int64 range, except the stream marker, which clamps to the maximum.

Track

The stuck track, null when the server did not include it, e.g. NodeLink reporting the stall after the track was already reset.

[JsonPropertyName("track")]
[JsonInclude]
public Track? Track { get; }

Property Value

Track