Class LyricsPlugin

Readonly name

init

• init(player): void

• Initialize the plugin with the player instance Called once when the player is initialized

  Parameters

  • player: Player<QueueContext, []>

    The player instance to attach to

  Returns void

getLyrics

• getLyrics(track, config?): Promise<null | LyricsResult>

• Fetch lyrics for a track

  Parameters

  • track: Track<CommonUserData, CommonPluginInfo>

    The track to fetch lyrics for
  • Optional config: LyricsConfig

    Configuration for lyrics sources

  Returns Promise<null | LyricsResult>

getCurrentLine

• getCurrentLine(lyrics, position): null | LyricsLine

• Get the current lyric line based on playback position

  Parameters

  • lyrics: LyricsResult
  • position: number

  Returns null | LyricsLine

formatLyrics

• formatLyrics(lyrics, maxLength?): string

• Format lyrics for display

  Parameters

  • lyrics: LyricsResult
  • maxLength: number = 2000

  Returns string