react-native-spotify

A react native module for the Spotify SDK

Install

To add react-native-spotify to your project, cd into your project directory and run the following commands:

npm install --save https://github.com/lufinkey/react-native-spotify
react-native link react-native-spotify

Next, do the manual setup for each platform:

iOS

Manually add the Frameworks from node_modules/react-native-spotify/ios/external/SpotifySDK to Embedded Binaries in your project settings. Then add ../node_modules/react-native-spotify/ios/external/SpotifySDK to Framework Search Paths in your project settings.

Android

Edit android/build.gradle and add flatDir

...
allprojects {
	repositories {
		mavenLocal()
		jcenter()
		maven {
			// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
			url "$rootDir/../node_modules/react-native/android"
		}
		flatDir {
			dirs project(':react-native-spotify').file('libs'), 'libs'
		}
	}
}
...

Edit android/app/build.gradle and add packagingOptions

...
buildTypes {
    release {
        minifyEnabled enableProguardInReleaseBuilds
        proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
    }
}
packagingOptions {
    pickFirst 'lib/armeabi-v7a/libgnustl_shared.so'
    pickFirst 'lib/x86/libgnustl_shared.so'
}
...

If you have issues linking the module, please check that gradle is updated to the latest version and that your project is synced.

Usage

import Spotify from 'react-native-spotify';

Types

Auth

Contains information about authentication data
- Properties
  - accessToken - A token used to communicate with the Spotify API
  - refreshToken - An encrypted token used to get a new access token when it expires. This should be encrypted by your token swap service, as per OAuth standards.
  - expireTime - The time that the access token expires, in milliseconds from January 1, 1970 00:00:00 UTC
PlaybackState

Contains information about the current state of the player
- Properties
  - playing - boolean indicating whether the player is playing
  - repeating - boolean indicating whether the player is repeating
  - shuffling - boolean indicating whether the player is shuffling
  - activeDevice - boolean indicating whether the current device is the one playing
  - position - the position of the player in the current track, in seconds
PlaybackTrack

Contains information about a track in the playback queue
- Properties
  - name - The title of the track
  - uri - The uri of the track
  - contextName - The name of the playlist or album that the track is being played from
  - contextUri - The uri of the playlist or album that the track is being played from
  - artistName - The name of the track's artist
  - artistUri - The uri of the track's artist
  - albumName - The name of the album that the track belongs to
  - albumUri - The uri of the album that the track belongs to
  - albumCoverArtURL - A URL for the album art image
  - indexInContext - The track index in the playlist or album that the track is being played from
PlaybackMetadata

Contains information about the previous, current, and next tracks in the player
- Properties
  - prevTrack - A PlaybackTrack with information about the previous track
  - currentTrack - A PlaybackTrack with information about the current track
  - nextTrack - A PlaybackTrack with information about the next track
Error

Passed to callback functions to indicate something went wrong during the function call. Right now, there are some uniformity issues between iOS and Android on the errors that get returned, but for now, use the message attribute to display a message to the user.
- Properties
  - domain - A string indicating what part of the system the error belongs to
  - code - An integer containing the actual error code of the error
  - message - A string containing a user-readable description of the error

Initialization/Authorization Methods

initialize( options, ( loggedIn, error? ) => {} )

Initializes the Spotify module and resumes a logged in session if there is one.
- Parameters
  - options - an object with options to pass to the Spotify Module
    - clientID - Your spotify application's ClientID that you registered with spotify here
    - redirectURL - The redirect URL to use when you've finished logging in. You NEED to set this URL for your application here, otherwise the login screen will not close
    - sessionUserDefaultsKey - The preference key to use to store session data for this module
    - scopes - An array of scopes to use in the application. A list of scopes can be found here
    - tokenSwapURL - The URL to use to swap an authentication code for an access token
    - tokenRefreshURL - The URL to use to get a new access token from a refresh token
  - loggedIn - A boolean indicating whether or not a session was automatically logged back in
  - error - An error that occurred during initialization, or null if no error occurred
isInitialized()

Checks if the Spotify module has been initialized yet.
- Returns
  - true if the Spotify module has been initialized
  - false if the Spotify module has not been initialized
isInitializedAsync( ( initialized ) => {} )

Checks if the Spotify module has been initialized yet, but passes the result to a callback rather than returning it.
- Parameters
  - initialized - A boolean indicating whether or not the Spotify module has been initialized
login( ( loggedIn, error? ) => {} )

Opens a UI to log into Spotify.
- Parameters
  - loggedIn - A boolean indicating whether or not the client was logged in
  - error - An error that occurred during login, or null if no error occurred
isLoggedIn()

Checks if the client is logged in.
- Returns
  - true if the client is logged in
  - false if the client is not logged in
isLoggedInAsync( ( loggedIn ) => {} )

Checks if the client is logged in, but passes the result to a callback rather than returning it.
- Parameters
  - loggedIn - A boolean indicating whether or not the client is logged in
logout( ( error? ) => {} )

Logs out of Spotify.
- Parameters
  - error - An error that occurred during logout, or null if no error occurred
getAuth()

Gives information about authentication data.
- Returns
  - An Auth object
getAuthAsync( ( auth ) => {} )

Gives information about authentication data, but passes the result to a callback rather than returning it.
- Parameters
  - auth - An Auth object

Playback Methods

playURI( spotifyURI, startIndex, startPosition, ( error? ) => {} )

Play a Spotify URI.
- Parameters
  - spotifyURI - The Spotify URI to play
  - startIndex - The index of an item that should be played first, e.g. 0 - for the very first track in the playlist or a single track
  - startPosition - starting position for playback in seconds
  - error - An error object if an error occurred, or null if no error occurred
queueURI( spotifyURI, ( error? ) => {} )

Queue a Spotify URI.
- Parameters
  - spotifyURI - The Spotify URI to queue
  - error - An error object if an error occurred, or null if no error occurred
setPlaying( playing, ( error? ) => {} )

Set the “playing” status of the player.
- Parameters
  - playing - pass true to resume playback, or false to pause it
  - error - An error object if an error occurred, or null if no error occurred
getPlaybackState()

Gives the player's current state.
- Returns
  - A PlaybackState object, or null if the player has not been initialized
getPlaybackStateAsync( ( playbackState? ) => {} )

Gives the player's current state, but passes the result to a callback rather than returning it.
- Parameters
  - playbackState - A PlaybackState object, or null if the player has not been initialized
getPlaybackMetadata()

Gives information about the previous, current, and next tracks in the player
- Returns
  - A PlaybackMetadata object, or null if the player has not been initialized
getPlaybackMetadataAsync( ( playbackMetadata? ) => {} )

Gives information about the previous, current, and next tracks in the player, but passes the result to a callback rather than returning it.
- Parameters
  - playbackMetadata - A PlaybackMetadata object, or null if the player has not been initialized
skipToNext( ( error? ) => {} )

Skips to the next track.
- Parameters
  - error - An error object if an error occurred, or null if no error occurred
skipToPrevious( ( error? ) => {} )

Skips to the previous track.
- Parameters
  - error - An error object if an error occurred, or null if no error occurred
setShuffling( shuffling, ( error? ) => {] )

Enables or disables shuffling on the player.
- Parameters
  - shuffling - true to enable shuffle, false to disable it
  - error - An error object if an error occurred, or null if no error occurred
setRepeating( repeating, ( error? ) => {} )

Enables or disables repeating on the player.
- Parameters
  - repeating - true to enable repeat, false to disable it
  - error - An error object if an error occurred, or null if no error occurred

Metadata Methods

sendRequest( endpoint, method, params, isJSONBody, ( result?, error? ) => {} )

Sends a general request to the spotify api.
- Parameters
  - endpoint - the api endpoint, without a leading slash, e.g. v1/browse/new-releases
  - method - the HTTP method to use
  - params - the request parameters
  - isJSONBody - whether or not to send the parameters as json in the body of the request
  - result - the request result object
  - error - An error object if an error occurred, or null if no error occurred
getMe( ( result?, error? ) => {} )

Retrieves information about the logged in Spotify user.
- Parameters
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
search( query, types, options?, ( result?, error? ) => {} )

Sends a search request to spotify.
- Parameters
  - query - The search query string. Same as the q parameter on the search endpoint
  - types - An array of item types to search for. Valid types are: album, artist, playlist, and track.
  - options - A map of other optional parameters to specify for the query
  - result - The search result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getAlbum( albumID, options?, ( result?. error? ) => {} )

Gets Spotify catalog information for a single album.
- Parameters
  - albumID - The Spotify ID for the album
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getAlbums( albumIDs, options?, ( result?, error? ) => {} )

Gets Spotify catalog information for multiple albums identified by their Spotify IDs.
- Parameters
  - albumIDs - An array of the Spotify IDs for the albums
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getAlbumTracks( albumID, options?, ( result?, error? ) => {} )

Gets Spotify catalog information about an album’s tracks.
- Parameters
  - albumID - The Spotify ID for the album
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getArtist( artistID, options?, ( result?, error? ) => {} )

Gets Spotify catalog information for a single artist.
- Parameters
  - artistID - The Spotify ID for the artist
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getArtists( artistIDs, options?, ( result?, error? ) => {} )

Gets Spotify catalog information for several artists based on their Spotify IDs.
- Parameters
  - artistIDs - An array of the Spotify IDs for the artists
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getArtistAlbums( artistID, options?, ( result?, error? ) => {} )

Gets Spotify catalog information about an artist’s albums.
- Parameters
  - artistID - The Spotify ID for the artist
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getArtistTopTracks( artistID, country, options?, ( result?, error? ) => {} )

Gets Spotify catalog information about an artist’s top tracks by country.
- Parameters
  - artistID - The Spotify ID for the artist
  - country - The country: an ISO 3166-1 alpha-2 country code.
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getArtistRelatedArtists( artistID, options?, ( result?, error? ) => {} )

Gets Spotify catalog information about artists similar to a given artist.
- Parameters
  - artistID - The Spotify ID for the artist
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getTrack( trackID, options?, ( result?, error? ) => {} )

Gets Spotify catalog information for a single track identified by its unique Spotify ID.
- Parameters
  - trackID - The Spotify ID for the track
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getTracks( trackIDs, options?, ( result?, error? ) => {} )

Gets Spotify catalog information for multiple tracks based on their Spotify IDs.
- Parameters
  - trackIDs - An array of the Spotify IDs for the tracks
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getTrackAudioAnalysis( trackID, options?, ( result?, error? ) => {} )

Gets a detailed audio analysis for a single track identified by its unique Spotify ID.
- Parameters
  - trackID - The Spotify ID for the track
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getTrackAudioFeatures( trackID, options?, ( result?, error? ) => {} )

Gets audio feature information for a single track identified by its unique Spotify ID.
- Parameters
  - trackID - The Spotify ID for the track
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred
getTracksAudioFeatures( trackIDs, options?, ( result?, error? ) => {} )

Gets audio features for multiple tracks based on their Spotify IDs.
- Parameters
  - trackIDs - An array of the Spotify IDs for the tracks
  - options - A map of other optional parameters to specify for the query
  - result - The request result object. An example response can be seen here
  - error - An error object if an error occurred, or null if no error occurred

jeserodz / react-native-spotify Goto Github PK