common

1.0

common/dev.brahmkshatriya.echo.common.models/Lyrics

Lyrics

data class Lyrics(val id: String, val title: String, val subtitle: String? = null, val lyrics: Lyrics.Lyric? = null, val extras: Map<String, String> = emptyMap())

Represents lyrics of a song, can be loaded later in LyricsClient.loadLyrics.

See also

Constructors

constructor(id: String, title: String, subtitle: String? = null, lyrics: Lyrics.Lyric? = null, extras: Map<String, String> = emptyMap())

Types

data class Item(val text: String, val startTime: Long, val endTime: Long)

Represents a timed lyric item.

sealed class Lyric

Represents a lyric of a song.

data class Simple(val text: String) : Lyrics.Lyric

Represents a simple lyric of a song.

data class Timed(val list: List<Lyrics.Item>, val fillTimeGaps: Boolean = true) : Lyrics.Lyric

Represents a timed lyric of a song.

data class WordByWord(val list: List<List<Lyrics.Item>>, val fillTimeGaps: Boolean = true) : Lyrics.Lyric

Represents a word-by-word lyric of a song.

Properties

val extras: Map<String, String>

additional information about the lyrics.

the unique identifier of the lyrics.

val lyrics: Lyrics.Lyric? = null

the lyrics of the song.

val subtitle: String? = null

the subtitle of the lyrics.

val title: String

the title of the lyrics.