[!IMPORTANT] For LavaSrc v3 (Lavaplayer v1 & Lavalink v3) look here
A collection of additional Lavaplayer v2, LavaSearch & LavaLyrics Audio Source Managers and Lavalink v4 Plugin.
[!IMPORTANT] Tracks from Spotify & Apple Music don't actually play from their sources, but are instead resolved via the configured providers
Replace x.y.z with the latest version number
Snapshot builds are available in https://maven.topi.wtf/snapshots with the short commit hash as the version
To get a Spotify clientId & clientSecret you must go here and create a new application.
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
// create a new SpotifySourceManager with the default providers, clientId, clientSecret, spDc, countryCode and AudioPlayerManager and register it
// spDc is only needed if you want to use it with LavaLyrics
var spotify = new SpotifySourceManager(clientId, clientSecret, spDc, countryCode, () -> playerManager, DefaultMirroringAudioTrackResolver);
playerManager.registerSourceManager(spotify);
Alternatively, you can follow this guide
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
// create a new AppleMusicSourceManager with the standard providers, apple music api token, countrycode and AudioPlayerManager and register it
var appleMusic = new AppleMusicSourceManager(null, mediaAPIToken , "us", playerManager);
playerManager.registerSourceManager(appleMusic);
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
// create a new DeezerSourceManager with the master decryption key and register it
var deezer = new DeezerSourceManager("the master decryption key", "your arl", formats);
playerManager.registerSourceManager(deezer);
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
// create a new YandexMusicSourceManager with the access token and register it
var yandex = new YandexMusicSourceManager("...");
playerManager.registerSourceManager(yandex);
Get list of all voices and languages supported here
AudioPlayerManager playerManager = new DefaultAudioPlayerManager();
// create a new FloweryTTSSourceManager
playerManager.registerSourceManager(new FloweryTTSSourceManager());
// create a new FloweryTTSSourceManager with a default voice
playerManager.registerSourceManager(new FloweryTTSSourceManager("..."));
This plugin requires Lavalink v4
or greater
To install this plugin either download the latest release and place it into your plugins
folder or add the following into your application.yml
Note For a full
application.yml
example see here
Replace x.y.z with the latest version number
lavalink:
plugins:
- dependency: "com.github.topi314.lavasrc:lavasrc-plugin:x.y.z"
repository: "https://maven.lavalink.dev/releases" # this is optional for lavalink v4.0.0-beta.5 or greater
snapshot: false # set to true if you want to use snapshot builds (see below)
Snapshot builds are available in https://maven.lavalink.dev/snapshots with the short commit hash as the version
For all supported urls and queries see here
To get your Spotify clientId, clientSecret go here & then copy them into your application.yml
like the following.
To get your Spotify spDc cookie go here
To get your Apple Music api token go here
To get your Deezer arl cookie go here
To get your Yandex Music access token go here
(YES plugins
IS AT ROOT IN THE YAML)
plugins:
lavasrc:
providers: # Custom providers for track loading. This is the default
# - "dzisrc:%ISRC%" # Deezer ISRC provider
# - "dzsearch:%QUERY%" # Deezer search provider
- "ytsearch:\"%ISRC%\"" # Will be ignored if track does not have an ISRC. See https://en.wikipedia.org/wiki/International_Standard_Recording_Code
- "ytsearch:%QUERY%" # Will be used if track has no ISRC or no track could be found for the ISRC
# you can add multiple other fallback sources here
sources:
spotify: false # Enable Spotify source
applemusic: false # Enable Apple Music source
deezer: false # Enable Deezer source
yandexmusic: false # Enable Yandex Music source
flowerytts: false # Enable Flowery TTS source
youtube: true # Enable YouTube search source (https://github.com/topi314/LavaSearch)
lyrics-sources:
spotify: false # Enable Spotify lyrics source
deezer: false # Enable Deezer lyrics source
youtube: false # Enable YouTube lyrics source
yandexmusic: false # Enable Yandex Music lyrics source
spotify:
clientId: "your client id"
clientSecret: "your client secret"
# spDc: "your sp dc cookie" # the sp dc cookie used for accessing the spotify lyrics api
countryCode: "US" # the country code you want to use for filtering the artists top tracks. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
playlistLoadLimit: 6 # The number of pages at 100 tracks each
albumLoadLimit: 6 # The number of pages at 50 tracks each
resolveArtistsInSearch: true # Whether to resolve artists in track search results (can be slow)
localFiles: false # Enable local files support with Spotify playlists. Please note `uri` & `isrc` will be `null` & `identifier` will be `"local"`
applemusic:
countryCode: "US" # the country code you want to use for filtering the artists top tracks and language. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
mediaAPIToken: "your apple music api token" # apple music api token
# or specify an apple music key
keyID: "your key id"
teamID: "your team id"
musicKitKey: |
-----BEGIN PRIVATE KEY-----
your key
-----END PRIVATE KEY-----
playlistLoadLimit: 6 # The number of pages at 300 tracks each
albumLoadLimit: 6 # The number of pages at 300 tracks each
deezer:
masterDecryptionKey: "your master decryption key" # the master key used for decrypting the deezer tracks. (yes this is not here you need to get it from somewhere else)
# arl: "your deezer arl" # the arl cookie used for accessing the deezer api this is optional but required for formats above MP3_128
formats: [ "FLAC", "MP3_320", "MP3_256", "MP3_128", "MP3_64", "AAC_64" ] # the formats you want to use for the deezer tracks. "FLAC", "MP3_320", "MP3_256" & "AAC_64" are only available for premium users and require a valid arl
yandexmusic:
accessToken: "your access token" # the token used for accessing the yandex music api. See https://github.com/TopiSenpai/LavaSrc#yandex-music
playlistLoadLimit: 1 # The number of pages at 100 tracks each
albumLoadLimit: 1 # The number of pages at 50 tracks each
artistLoadLimit: 1 # The number of pages at 10 tracks each
flowerytts:
voice: "default voice" # (case-sensitive) get default voice from here https://api.flowery.pw/v1/tts/voices
translate: false # whether to translate the text to the native language of voice
silence: 0 # the silence parameter is in milliseconds. Range is 0 to 10000. The default is 0.
speed: 1.0 # the speed parameter is a float between 0.5 and 10. The default is 1.0. (0.5 is half speed, 2.0 is double speed, etc.)
audioFormat: "mp3" # supported formats are: mp3, ogg_opus, ogg_vorbis, aac, wav, and flac. Default format is mp3
youtube:
countryCode: "US" # the country code you want to use for searching lyrics via ISRC. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
LavaSrc adds the following fields to tracks & playlists in Lavalink
Field | Type | Description |
---|---|---|
albumName | ?string | The name of the album |
albumArtUrl | ?string | The url of the album art |
artistUrl | ?string | The url of the artist |
artistArtworkUrl | ?string | The url of the artist artwork |
previewUrl | ?string | The url of the preview |
isPreview | bool | Whether the track is a preview |
Field | Type | Description |
---|---|---|
type | Playlist Type | The type of the playlist |
url | ?string | The url of the playlist |
artworkUrl | ?string | The url of the playlist artwork |
author | ?string | The author of the playlist |
totalTracks | ?int | The total number of tracks in the playlist |
Type | Description |
---|---|
album | The playlist is an album |
playlist | The playlist is a playlist |
artist | The playlist is an artist |
recommendations | The playlist is a recommendations playlist |
spsearch:animals architects
(check out Spotify Search Docs for advanced search queries like isrc & co)sprec:seed_artists=3ZztVuWxHzNpl0THurTFCv,4MzJMcHQBl9SIYSjwWn8QW&seed_genres=metalcore&seed_tracks=5ofoB8PFmocBXFBEWVb6Vz,6I5zXzSDByTEmYZ7ePVQeB
(check out Spotify Recommendations Docs for the full query parameter list)plugins.lavasrc.spotify.localFiles: true
. Please note uri
& isrc
will be null
& identifier
will be "local"
)(including new regional links like https://open.spotify.com/intl-de/track/0eG08cBeKk0mzykKjw4hcQ)
amsearch:animals architects
dzsearch:animals architects
dzisrc:USEP42058010
ymsearch:animals architects
ymrec:71663565
(ymrec:{TRACK_ID}
)You can read about all the available options here, a list of available voices is here
ftts://hello%20world
ftts://hello%20world?audio_format=ogg_opus&translate=False&silence=1000&speed=1.0&voice=09924826-684f-51e9-825b-cf85aed2b2cf