Class LyricsLineEventArgs

Namespace

Nyra.EventArgs

Assembly

Nyra.dll

A lyrics line became current during playback.

public sealed class LyricsLineEventArgs : EventArgs

Inheritance

object

EventArgs

LyricsLineEventArgs

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

Line

The line that became current.

[JsonPropertyName("line")]
[JsonInclude]
public SyncedLyricsLine Line { get; }

Property Value

SyncedLyricsLine

Remarks

Absorbs a null the server sends, the getter materializes an empty line, the event reaches user handlers even when the frame carries none.

LineIndex

The index of the line in the lyrics, counting the lines exactly as the server's array carries them, a null entry the wire carried does not shift it, while LyricsFoundEventArgs drops null entries from the list it exposes, so the index only addresses that filtered list when the wire carried no nulls.

[JsonPropertyName("lineIndex")]
[JsonInclude]
public int LineIndex { get; }

Property Value

int

Skipped

True when the line is out of step with playback, the event was emitted after the line's timestamp had already passed, or the playback position jumped past earlier lines (a seek, or the subscription starting mid-track).

[JsonPropertyName("skipped")]
[JsonInclude]
public bool Skipped { get; }

Property Value

bool