common/dev.brahmkshatriya.echo.common.clients/LyricsClient

LyricsClient

interface LyricsClient : ExtensionClient

Used to get the lyrics for track.

Can be implemented by both:

To support lyrics search from user query. Use LyricsSearchClient instead.

See also

Inheritors

Functions

Link copied to clipboard
abstract suspend fun getSettingItems(): List<Setting>

List of Settings to be displayed in the settings screen

Link copied to clipboard
abstract suspend fun loadLyrics(lyrics: Lyrics): Lyrics

Loads the unloaded lyrics.

Link copied to clipboard
open suspend fun onExtensionSelected()

Only called when an extension is selected by the user, not when the extension is loaded Use the onInitialize for doing stuff to initialize the extension

Link copied to clipboard
open suspend fun onInitialize()

Called when the extension is loaded, called after all the injections are done. Only called once

Link copied to clipboard
abstract suspend fun searchTrackLyrics(clientId: String, track: Track): Feed<Lyrics>

Searches for the unloaded lyrics of a track.

Link copied to clipboard
abstract fun setSettings(settings: Settings)

Called when the extension is initialized, to provide the Settings to the extension