-
Notifications
You must be signed in to change notification settings - Fork 12
API
- spotify.Session
- Properties
- spotify.AudioPlayer
- Methods
- Events
- spotify.Playlist
- Methods
- Properties
- spotify.Album
- Properties
- spotify.Artist
- Properties
- spotify.Track
- Properties
Authenticate the user with the Spotify API
spotify.authenticate(clientId, tokenExchangeURL, [scopes], callback)the clientId supplied by Spotify.
The URL for your token exchange service. See setting up a token exchange service
Custom scopes to request from the Spotify authentication service
The callback gets two arguments error and session. session is a spotify.Session object.
Search albums, artists or tracks. Return a maximum of 20 items. Use multiple requests with offset to receive more results.
spotify.search(query, searchType, [offset], session, callback)The query to search for.
this can be one of three strings:
-
artistto perform an artist search. -
albumto perform an album search. -
trackto perform a track search.
The starting index of the search results. If omitted the search will start from the first entry.
The spotify.Session object to use for authentication.
The callback gets two arguments error and result. result is an array of partial items. Each item has the following properties:
-
name. The name of the item. -
uri. The URI of the item.
Use the uri with the correct spotify object to promote a partial item to a full item.
For Example (Get the largest image for an artist from the search results):
var session = ...a valid spotify.Session object...
var item = ...a single artist search item.....
spotify.Artist(item.uri, session, function(error, artist) {
var image = artist.largestImage;
console.log('Image URL: %s', image.imageURL);
console.log('Image aspect ratio: %f', image.aspect);
console.log('Image size: %s', image.aspect);
});Normally a spotify.Session object is returned from spotify.authenticate() but you can use the spotify.Session object to store the session for later use. A session is valid for 24 hours after which the user will need to login again.
var session = spotify.Session({username: 'someUsername', credentials: 'AFD42....GD43'});The username of the user.
An access token to verify the session.
The constructor for a new spotify.AudioPlayer object.
spotify.AudioPlayer(companyName, appName, session, callback)Your company name
Your application name
The user's spotify.Session object.
The callback gets two arguments error and an spotify.AudioPlayer object, ready to start playing tracks.
These examples show how to construct a spotify.AudioPlayer and play a track.
spotify.AudioPlayer('Your-Company-Name', 'Your-App-Name', session, function(error, audioPlayer) {
audioPlayer.playURI('spotify:track:6JEK0CvvjDjjMUBFoXShNZ');
});