Class LyricsData

Namespace

Nyra.Entities

Assembly

Nyra.dll

Lyrics of a track, as resolved by the node's providers.

public sealed record LyricsData : IEquatable<LyricsData>

Inheritance

object

LyricsData

Implements

IEquatable<LyricsData>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Lines

The timed lines of the lyrics, null when there are none, plain providers can also report an empty list.

[JsonPropertyName("lines")]
[JsonInclude]
public IReadOnlyList<LyricsLine>? Lines { get; }

Property Value

IReadOnlyList<LyricsLine>

Message

Present only when the load failed with Error.

[JsonPropertyName("message")]
[JsonInclude]
public string? Message { get; }

Property Value

string

Name

Display label.

[JsonPropertyName("name")]
[JsonInclude]
public string? Name { get; }

Property Value

string

Remarks

NodeLink sends the track title or a provider variant label, LavaLyrics the lyrics source name.

Provider

The provider the lyrics came from.

[JsonPropertyName("provider")]
[JsonInclude]
public string? Provider { get; }

Property Value

string

Severity

Present only when the load failed with Error.

[JsonPropertyName("severity")]
[JsonInclude]
public ErrorSeverity? Severity { get; }

Property Value

ErrorSeverity?

Synced

Whether the lines carry timing information.

[JsonPropertyName("synced")]
[JsonInclude]
public bool? Synced { get; }

Property Value

bool?

Text

Plain lyrics text, when there are no timed lines, filled by LavaLyrics.

[JsonPropertyName("text")]
[JsonInclude]
public string? Text { get; }

Property Value

string

Methods

Equals(LyricsData?)

Indicates whether the lyrics carry the same members.

public bool Equals(LyricsData? other)

Parameters

other LyricsData

The lyrics to compare with.

Returns

bool

Whether the members match, the timed lines compared by content.

GetHashCode()

Returns a hash of the lyrics' comparable members.

public override int GetHashCode()

Returns

int

The hash code.

ToString()

Returns the lyrics data with the normalized line count.

public override string ToString()

Returns

string

The data's public members, the raw backing field stays out of it.