Skip to content

synced

Synced lyrics provider using the syncedlyrics library

Synced ¤

Bases: LyricsProvider

Lyrics provider for synced lyrics using the syncedlyrics library Currently supported websites: Deezer, NetEase

extract_lyrics(url, **kwargs) ¤

Extracts the lyrics from the given url.

Arguments¤
  • url: The url to extract the lyrics from.
  • kwargs: Additional arguments.
Returns¤
  • The lyrics of the song or None if no lyrics were found.
Source code in spotdl/providers/lyrics/synced.py
35
36
37
38
39
40
41
42
43
44
45
46
47
def extract_lyrics(self, url: str, **kwargs) -> Optional[str]:
    """
    Extracts the lyrics from the given url.

    ### Arguments
    - url: The url to extract the lyrics from.
    - kwargs: Additional arguments.

    ### Returns
    - The lyrics of the song or None if no lyrics were found.
    """

    raise NotImplementedError

get_lyrics(name, artists, **_) ¤

Try to get lyrics using syncedlyrics

Arguments¤
  • name: The name of the song.
  • artists: The artists of the song.
  • kwargs: Additional arguments.
Returns¤
  • The lyrics of the song or None if no lyrics were found.
Source code in spotdl/providers/lyrics/synced.py
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_lyrics(self, name: str, artists: List[str], **_) -> Optional[str]:
    """
    Try to get lyrics using syncedlyrics

    ### Arguments
    - name: The name of the song.
    - artists: The artists of the song.
    - kwargs: Additional arguments.

    ### Returns
    - The lyrics of the song or None if no lyrics were found.
    """

    lyrics = syncedlyrics.search(f"{name} - {artists[0]}", allow_plain_format=True)

    return lyrics

get_results(name, artists, **kwargs) ¤

Returns the results for the given song.

Arguments¤
  • name: The name of the song.
  • artists: The artists of the song.
  • kwargs: Additional arguments.
Returns¤
  • A dictionary with the results. (The key is the title and the value is the url.)
Source code in spotdl/providers/lyrics/synced.py
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def get_results(self, name: str, artists: List[str], **kwargs) -> Dict[str, str]:
    """
    Returns the results for the given song.

    ### Arguments
    - name: The name of the song.
    - artists: The artists of the song.
    - kwargs: Additional arguments.

    ### Returns
    - A dictionary with the results. (The key is the title and the value is the url.)
    """

    raise NotImplementedError