OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
frontends.tk.media.spotify_services_if.LyricsProviderIf Class Reference

Look up lyrics without exposing a concrete provider to the frontend. More...

Inherits Protocol.

Public Member Functions

LyricsResultIf|None get_lyrics (self, *str track_name, str artist_name, str album_name="", int duration_ms=0)
 Return synchronized or plain lyrics for one track.
 

Detailed Description

Look up lyrics without exposing a concrete provider to the frontend.

Member Function Documentation

◆ get_lyrics()

LyricsResultIf | None frontends.tk.media.spotify_services_if.LyricsProviderIf.get_lyrics (   self,
*str  track_name,
str  artist_name,
str   album_name = "",
int   duration_ms = 0 
)

Return synchronized or plain lyrics for one track.

Parameters
track_nameTrack title used for the lyrics lookup.
artist_nameArtist name used for the lyrics lookup.
album_nameOptional album name used to improve lookup accuracy.
duration_msOptional track duration in milliseconds used to improve matching.
Returns
Matching lyrics result, or None when lyrics are unavailable.

The documentation for this class was generated from the following file: