spotify_sdk

pub package Dry Run licence

Description

This will be a spotify_sdk package for flutter using both the spotify-app-remote sdk and spotify-auth library. The auth library is needed to get the authentication token to work with the web api.

Setup

Android

From the Spotify Android SDK Quick Start. You need two things:

  1. Register your app in the spotify developer portal. You also need to create a sha-1 fingerprint and add this and your package name to the app settings on the dashboard as well as a redirect url.
  2. download the current Spotify Android SDK. Here you need the spotify-app-remote-.aar and spotify-auth-.aar.

After you are all setup you need to add the *.aar files to your Android Project as Modules. See the Spotify Android SDK Quick Start for detailed information.

Important here is the naming so that the package can find the modules.

  • Remote: spotify-app-remote
  • Auth: spotify-auth

Web

  1. Register your app in the spotify developer portal. You need to provide a redirect URL which points to a dedicated page on a website you own.

  2. Paste the following onto the webpage, which you linked to in your redirect URL.

  <!DOCTYPE html>
  <html>
  <head>
    <title>Authenticating Spotify</title>
  </head>
  <body>
	<p>Please wait while we authenticate Spotify...</p>
	<script type="text/javascript">
		if(window.opener) {
			var error = getParameterByName('error');
			if(error) {
				window.opener.postMessage('?' + error, "*");
			} else {
				window.opener.postMessage(window.location.hash, "*");
			}
		} else {
			window.close();
		}

		function getParameterByName(name, url) {
		    if (!url) url = window.location.href;
		    name = name.replace(/[\[\]]/g, '\\$&');
		    var regex = new RegExp('[?&]' + name + '(=([^&#]*)|&|#|$)'),
		        results = regex.exec(url);
		    if (!results) return null;
		    if (!results[2]) return '';
		    return decodeURIComponent(results[2].replace(/\+/g, ' '));
		}
	</script>
</body>
</html>

You need Spotify Premium to access the Web SDK.

Usage

To start using this package you first have to connect to Spotify. To only connect you can do this with connectToSpotifyRemote(...) or getAuthenticationToken(...) in both of these methods you need the client id, given in the spotify dashboard and the redirect url you set in the settings on the dashboard.

  await SpotifySdk.connectToSpotifyRemote(clientId: "", redirectUrl: "")

If you want to use the web api as well you have to use this method to get the authentication token. You can specify multiple scopes by separating them with a comma "," as shown below. For more information on scopes you can refer to Spotify Authorization Scopes Guide

  var authenticationToken = await SpotifySdk.getAuthenticationToken(clientId: "", redirectUrl: "", scope: "app-remote-control,user-modify-playback-state,playlist-read-private");

Have a look in the example for detailed insights on how you can use this package.

Api

Connecting/Authenticating

FunctionDescriptionAndroidiOSWeb
connectToSpotifyRemoteConnects the App to Spotify:heavy_check_mark::construction_worker::heavy_check_mark:
getAuthenticationTokenGets the Authentication Token that you can use to work with the Web Api:heavy_check_mark::construction_worker::heavy_check_mark:
logoutlogs the user out and disconnects the app connection:heavy_check_mark::construction_worker::heavy_check_mark:

Player Api

FunctionDescriptionAndroidiOSWeb
getCrossfadeStateGets the current crossfade state:heavy_check_mark::construction_worker::x:
getPlayerStateGets the current player state:heavy_check_mark::construction_worker::heavy_check_mark:
pausePauses the current track:heavy_check_mark::construction_worker::heavy_check_mark:
playPlays the given spotifyUri:heavy_check_mark::construction_worker::heavy_check_mark:
queueQueues given spotifyUri:heavy_check_mark::construction_worker::heavy_check_mark:
resumeResumes the current track:heavy_check_mark::construction_worker::heavy_check_mark:
skipNextSkips to next track:heavy_check_mark::construction_worker::heavy_check_mark:
skipPreviousSkips to previous track:heavy_check_mark::construction_worker::heavy_check_mark:
seekToSeeks the current track to the given position in milliseconds:heavy_check_mark::construction_worker::construction_worker:
seekToRelativePositionAdds to the current position of the track the given milliseconds:heavy_check_mark::construction_worker::construction_worker:
subscribeToPlayerContextSubscribes to the current player context:heavy_check_mark::construction_worker::heavy_check_mark:
subscribeToPlayerStateSubscribes to the current player state:heavy_check_mark::construction_worker::heavy_check_mark:
getCrossfadeStateGets the current crossfade state:heavy_check_mark::construction_worker::x:
toggleShuffleCycles through the shuffle modes:heavy_check_mark::construction_worker::construction_worker:
toggleRepeatCycles through the repeat modes:heavy_check_mark::construction_worker::construction_worker:

Images Api

FunctionDescriptionAndroidiOSWeb
getImageGet the image from the given spotifyUri:heavy_check_mark::construction_worker::construction_worker:

User Api

FunctionDescriptionAndroidiOSWeb
addToLibraryAdds the given spotifyUri to the users library:heavy_check_mark::construction_worker::construction_worker:
getCapabilitiesGets the current users capabilities:heavy_check_mark::construction_worker::construction_worker:
getLibraryStateGets the current library state:heavy_check_mark::construction_worker::construction_worker:
removeFromLibraryRemoves the given spotifyUri to the users library:heavy_check_mark::construction_worker::construction_worker:
subscribeToCapabilitiesSubscribes to the current users capabilities:heavy_check_mark::construction_worker::construction_worker:
subscribeToUserStatusSubscrives to the current users status:heavy_check_mark::construction_worker::construction_worker:

Connect Api

FunctionDescriptionAndroidiOSWeb
connectSwitchToLocalDeviceSwitch to play music on this (local) device:construction_worker::construction_worker::construction_worker:

Content Api

FunctionDescriptionAndroidiOSWeb
getChildrenOfItemtbd:construction_worker::construction_worker::construction_worker:
getRecommendedContentItemstbd:construction_worker::construction_worker::construction_worker:
playContentItemtbd:construction_worker::construction_worker::construction_worker:

Official Spotify Docs

Libraries

album
artist
capabilities
connection_status
crossfade_state
image_uri
library_state
player_context
player_options
player_restrictions
player_state
spotify_sdk
spotify_sdk
track
user_status