LavaSrc

Once you have registered a source manager (like Spotify, Deezer, Yandex, Vk, or Apple Music), you can enable lyrics and search capabilities by registering the source with LyricsManager and SearchManager respectively.

// Example for Spotify
var lyricsManager = new LyricsManager();
lyricsManager.registerLyricsManager(spotify);

var searchManager = new SearchManager();
searchManager.registerSearchManager(spotify);

Mirroring is the process of resolving metadata from one source and using that metadata to retrieve a playable AudioTrack from a different, compatible source.

Because some platforms (like Spotify or Tidal) do not allow direct audio streaming through LavaSrc, they are marked as Mirror sources. To play music from these platforms, LavaSrc takes the resolved metadata and searches for a corresponding playable track in a source marked as Direct (such as Deezer or YouTube). You can also use any other source manager registered to your AudioPlayerManager as the target for mirroring.

LavaSrc requires Lavalink v4 or greater. You can install it by downloading the latest release to your plugins folder or by adding the dependency to your application.yml file.

When using application.yml, ensure the plugins key is at the root of the YAML structure.

lavalink:
  plugins:
    - dependency: "com.github.topi314.lavasrc:lavasrc-plugin:x.y.z"
      repository: "https://maven.lavalink.dev/releases"
      snapshot: false

Deezer requires an arl cookie. You can also specify preferred audio formats. Note that high-quality formats like FLAC require a premium account and a valid arl.

plugins:
  lavasrc:
    deezer:
      masterDecryptionKey: "your master decryption key"
      arl: "your deezer arl"
      formats: [ "FLAC", "MP3_320", "MP3_256", "MP3_128", "MP3_64", "AAC_64" ]

Apple Music requires an API token or an Apple Music key (including keyID, teamID, and musicKitKey).

plugins:
  lavasrc:
    applemusic:
      countryCode: "US"
      mediaAPIToken: "your apple music api token"
      # OR use a key:
      keyID: "your key id"
      teamID: "your team id"
      musicKitKey: |
        -----BEGIN PRIVATE KEY-----
        your key
        -----END PRIVATE KEY-----
      playlistLoadLimit: 6
      albumLoadLimit: 6

To use yt-dlp as a source, you must provide the path to the executable. You can also pass custom arguments for loading and playback.

plugins:
  lavasrc:
    ytdlp:
      path: "yt-dlp"
      searchLimit: 10
      mixPlaylistLoadLimit: 25
      playlistLoadLimit: 1000
      customLoadArgs: ["-q", "--no-warnings", "--flat-playlist", "--skip-download", "-J"]
      customPlaybackArgs: ["-q", "--no-warnings", "-f", "bestaudio", "-J"]

The YoutubeSearchManager supports two specific search prefixes to differentiate between standard YouTube searches and YouTube Music searches:

• ytsearch:<QUERY>: Performs a standard YouTube autocomplete search, returning text suggestions.
• ytmsearch:<QUERY>: Performs a YouTube Music autocomplete search, which can return tracks, albums, artists, and playlists.

When using ytmsearch:, the manager returns structured results including YoutubeAudioTrack and ExtendedAudioPlaylist objects.

// Example search prefixes
ytsearch:my query
ytmsearch:my query

To use Spotify, you must provide a clientId and clientSecret from the Spotify Developer Dashboard.

Key options:

• spDc: The Spotify sp_dc cookie, required for accessing the Spotify lyrics API.
• countryCode: ISO 3166-1 alpha-2 code (e.g., US) for filtering top tracks.
• preferPartnerApi: If true, uses the Spotify Partner API by default.
• localFiles: Enables local file support for Spotify playlists.

plugins:
  lavasrc:
    spotify:
      clientId: "your client id"
      clientSecret: "your client secret"
      spDc: "your sp dc cookie"
      countryCode: "US"
      playlistLoadLimit: 6
      albumLoadLimit: 6
      resolveArtistsInSearch: true
      localFiles: false
      preferPartnerApi: false
      preferV1SearchApi: false
      customTokenEndpoint: "http://localhost:8080/api/token"

To use yt-dlp as a source, provide the local file path to the yt-dlp executable.

AudioPlayerManager playerManager = new DefaultAudioPlayerManager();

// create a new YTDLPSourceManager with the path to the yt-dlp executable and register it
playerManager.registerSourceManager(new YTDLPSourceManager("path/to/yt-dlp"));