Skip navigation links
A B C D E F G H I L M N O P Q R S T U V W 

A

addConnectionStateCallback(ConnectionStateCallback) - Method in interface com.spotify.sdk.android.player.Player
 
addConnectionStateCallback(ConnectionStateCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
addNotificationCallback(Player.NotificationCallback) - Method in interface com.spotify.sdk.android.player.Player
 
addNotificationCallback(Player.NotificationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
albumCoverWebUrl - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
albumName - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
albumUri - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
artistName - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
artistUri - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
AudioController - Interface in com.spotify.sdk.android.player
AudioController provides a way to get access to the audio data and implement a custom audio playback logic.
AudioRingBuffer - Class in com.spotify.sdk.android.player
A ring buffer to hold audio data before they can be written to the audio output.
AudioRingBuffer(int) - Constructor for class com.spotify.sdk.android.player.AudioRingBuffer
 
AVR - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Device type for an audio/video receiver
awaitDestroyPlayer(Object, long, TimeUnit) - Static method in class com.spotify.sdk.android.player.Spotify
Release a player resource.

B

brandName - Variable in class com.spotify.sdk.android.player.Config
Device's brand name as stored in android.os.Build.MANUFACTURER
build() - Method in class com.spotify.sdk.android.player.SpotifyPlayer.Builder
Creates the player.
build(SpotifyPlayer.InitializationObserver) - Method in class com.spotify.sdk.android.player.SpotifyPlayer.Builder
Creates the player.
Builder(Config) - Constructor for class com.spotify.sdk.android.player.SpotifyPlayer.Builder
 

C

cacheAgeLimitInSeconds - Variable in class com.spotify.sdk.android.player.Config
The maximum age for any individual file stored in the cache.
cachePath - Variable in class com.spotify.sdk.android.player.Config
The location where cached files will be stored.
cacheSizeLimitInMegabytes - Variable in class com.spotify.sdk.android.player.Config
The maximum size allowed for all files stored in the cache.
clear() - Method in class com.spotify.sdk.android.player.AudioRingBuffer
Removes all items from the buffer.
clientId - Variable in class com.spotify.sdk.android.player.Config
A client ID that the app is using.
com.spotify.sdk.android.player - package com.spotify.sdk.android.player
Contains classes used for playing music.
COMPUTER - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Laptop or desktop computer
Config - Class in com.spotify.sdk.android.player
Class used to pass configuration parameters to the native SDK layer for initialization.
Config(Context, String, String) - Constructor for class com.spotify.sdk.android.player.Config
Create a new Config object used for initializing the global SpotifyPlayer instance.
Config(Context, String, String, Config.DeviceType) - Constructor for class com.spotify.sdk.android.player.Config
Create a new Config object used for initializing the global SpotifyPlayer instance.
Config.DeviceType - Class in com.spotify.sdk.android.player
The SDK represents device types as raw integers, but rather than dealing with an enum an abstract class is used, as we are missing some intermediate values and require a bit more granularity here than an enum can offer.
ConnectionStateCallback - Interface in com.spotify.sdk.android.player
Callback used to deliver information about connection state events.
Connectivity - Class in com.spotify.sdk.android.player
Class used for sending connectivity messages to the SDK.
Connectivity() - Constructor for class com.spotify.sdk.android.player.Connectivity
 
contextName - Variable in class com.spotify.sdk.android.player.Metadata
 
contextUri - Variable in class com.spotify.sdk.android.player.Metadata
 
create(Config) - Static method in class com.spotify.sdk.android.player.SpotifyPlayer
Create a new player instance.
create(Config, SpotifyPlayer.InitializationObserver) - Static method in class com.spotify.sdk.android.player.SpotifyPlayer
Create a new player instance with initialization observer.
CREATOR - Static variable in class com.spotify.sdk.android.player.Metadata
 
CREATOR - Static variable in class com.spotify.sdk.android.player.Metadata.Track
 
CREATOR - Static variable in class com.spotify.sdk.android.player.PlaybackState
 
currentTrack - Variable in class com.spotify.sdk.android.player.Metadata
 

D

describeContents() - Method in class com.spotify.sdk.android.player.Metadata
 
describeContents() - Method in class com.spotify.sdk.android.player.Metadata.Track
 
describeContents() - Method in class com.spotify.sdk.android.player.PlaybackState
 
destroy() - Method in interface com.spotify.sdk.android.player.Player
Destroys the native player.
destroy() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
destroyPlayer(Object) - Static method in class com.spotify.sdk.android.player.Spotify
Release a player resource.
DeviceType() - Constructor for class com.spotify.sdk.android.player.Config.DeviceType
 
displayName - Variable in class com.spotify.sdk.android.player.Config
Device's display name.
DONGLE - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Device type for a dongle-type device
durationMs - Variable in class com.spotify.sdk.android.player.Metadata.Track
 

E

equals(Object) - Method in class com.spotify.sdk.android.player.Metadata
 
equals(Object) - Method in class com.spotify.sdk.android.player.Metadata.Track
 
Error - Enum in com.spotify.sdk.android.player
 

F

fromNetworkType(int) - Static method in class com.spotify.sdk.android.player.Connectivity
Translate an Android connectivity type to a Connectivity constant for use with the SDK.

G

getMetadata() - Method in interface com.spotify.sdk.android.player.Player
 
getMetadata() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
getPlaybackState() - Method in interface com.spotify.sdk.android.player.Player
 
getPlaybackState() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
getPlayer(Config, Object, SpotifyPlayer.InitializationObserver) - Static method in class com.spotify.sdk.android.player.Spotify
Get (or possibly create) an instance of the player.
getPlayer(SpotifyPlayer.Builder, Object, SpotifyPlayer.InitializationObserver) - Static method in class com.spotify.sdk.android.player.Spotify
Get (or possibly create) an instance of the player with custom components.
getReferenceCount() - Static method in class com.spotify.sdk.android.player.Spotify
Check how many references to the player currently exists.
getValue() - Method in enum com.spotify.sdk.android.player.PlaybackBitrate
 

H

hashCode() - Method in class com.spotify.sdk.android.player.Metadata
 
hashCode() - Method in class com.spotify.sdk.android.player.Metadata.Track
 

I

IN_FIELD_SEPARATOR - Static variable in class com.spotify.sdk.android.player.Config
 
indexInContext - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
initialize(Config) - Method in interface com.spotify.sdk.android.player.Player
Initializes the native player.
initialize(Config) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
isActiveDevice - Variable in class com.spotify.sdk.android.player.PlaybackState
 
isInitialized() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
isLoggedIn() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
isPlaying - Variable in class com.spotify.sdk.android.player.PlaybackState
 
isRepeating - Variable in class com.spotify.sdk.android.player.PlaybackState
 
isShuffling - Variable in class com.spotify.sdk.android.player.PlaybackState
 
isShutdown() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
isTerminated() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 

L

login(String) - Method in interface com.spotify.sdk.android.player.Player
Logs in to the native player.
login(String) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Login to the player using OAuth token.
logout() - Method in interface com.spotify.sdk.android.player.Player
Log out from the native player.
logout() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Logout from the player.

M

Metadata - Class in com.spotify.sdk.android.player
Class which holds information about the current player state
Metadata(String, String, Metadata.Track, Metadata.Track, Metadata.Track) - Constructor for class com.spotify.sdk.android.player.Metadata
 
Metadata(Parcel) - Constructor for class com.spotify.sdk.android.player.Metadata
 
Metadata.Track - Class in com.spotify.sdk.android.player
 
MOBILE - Static variable in class com.spotify.sdk.android.player.Connectivity
The device is connected to a mobile network (EDGE or 3G).
modelName - Variable in class com.spotify.sdk.android.player.Config
Device's model name as stored in android.os.Build.MODEL.

N

name - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
nextTrack - Variable in class com.spotify.sdk.android.player.Metadata
 

O

oauthToken - Variable in class com.spotify.sdk.android.player.Config
Authorization token.
OFFLINE - Static variable in class com.spotify.sdk.android.player.Connectivity
The device is offline
onAudioDataDelivered(short[], int, int, int) - Method in interface com.spotify.sdk.android.player.AudioController
Called whenever SpotifyPlayer receives audio data.
onAudioDelivered(short[], int, int, int) - Method in interface com.spotify.sdk.android.player.Player.AudioDeliveredCallback
Called every time raw audio data is received.
onAudioDelivered(short[], int, int, int) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
onAudioFlush() - Method in interface com.spotify.sdk.android.player.AudioController
Called when the SpotifyPlayer has flushed the audio buffer.
onAudioFlush() - Method in interface com.spotify.sdk.android.player.Player.AudioFlushCallback
Called every time flush command is received.
onAudioFlush() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
onAudioPaused() - Method in interface com.spotify.sdk.android.player.AudioController
Called when audio playback should be paused (e.g.
onAudioResumed() - Method in interface com.spotify.sdk.android.player.AudioController
Called when audio playback should be resumed (e.g.
onConnectionMessage(String) - Method in interface com.spotify.sdk.android.player.ConnectionStateCallback
Connection message sent from the server to the user.
onError(Error) - Method in interface com.spotify.sdk.android.player.Player.OperationCallback
 
onError(Throwable) - Method in interface com.spotify.sdk.android.player.SpotifyPlayer.InitializationObserver
Called if the player thread failed to initialize.
onInitialized(SpotifyPlayer) - Method in interface com.spotify.sdk.android.player.SpotifyPlayer.InitializationObserver
Called when the Player thread is running and ready to process commands.
onLoggedIn() - Method in interface com.spotify.sdk.android.player.ConnectionStateCallback
Sent when the user has successfully logged in
onLoggedOut() - Method in interface com.spotify.sdk.android.player.ConnectionStateCallback
Sent when the user has finished logging out
onLoginFailed(Error) - Method in interface com.spotify.sdk.android.player.ConnectionStateCallback
Sent when login attempt fails.
onPlaybackError(Error) - Method in interface com.spotify.sdk.android.player.Player.NotificationCallback
 
onPlaybackEvent(PlayerEvent) - Method in interface com.spotify.sdk.android.player.Player.NotificationCallback
 
onSuccess() - Method in interface com.spotify.sdk.android.player.Player.OperationCallback
 
onTemporaryError() - Method in interface com.spotify.sdk.android.player.ConnectionStateCallback
Sent when service has been interrupted, usually by lack of network access.
osVersion - Variable in class com.spotify.sdk.android.player.Config
Device's OS version and supported ABI as stored in android.os.Build.VERSIONS.RELEASE and Build.SUPPORTED_ABIS

P

pause(Player.OperationCallback) - Method in interface com.spotify.sdk.android.player.Player
Pauses currently playing track.
pause(Player.OperationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Pause playback.
peek(short[]) - Method in class com.spotify.sdk.android.player.AudioRingBuffer
Gets elements without removing them from the buffer.
PlaybackBitrate - Enum in com.spotify.sdk.android.player
Configure the playback bitrate.
PlaybackState - Class in com.spotify.sdk.android.player
 
PlaybackState(boolean, boolean, boolean, boolean, long) - Constructor for class com.spotify.sdk.android.player.PlaybackState
 
PlaybackState(Parcel) - Constructor for class com.spotify.sdk.android.player.PlaybackState
 
Player - Interface in com.spotify.sdk.android.player
Any native player that connects to Spotify playback services must implement this interface.
Player.AudioDeliveredCallback - Interface in com.spotify.sdk.android.player
Interface used to register callback for audio data received from native player.
Player.AudioFlushCallback - Interface in com.spotify.sdk.android.player
Interface used to register callback for audio flush command received from native player.
Player.NotificationCallback - Interface in com.spotify.sdk.android.player
 
Player.OperationCallback - Interface in com.spotify.sdk.android.player
 
PlayerEvent - Enum in com.spotify.sdk.android.player
 
PlayerInitializationException - Exception in com.spotify.sdk.android.player
Exception that will be thrown by the Player if initialization fails.
PlayerInitializationException(String) - Constructor for exception com.spotify.sdk.android.player.PlayerInitializationException
 
PlayerInitializationException(Throwable) - Constructor for exception com.spotify.sdk.android.player.PlayerInitializationException
 
playUri(Player.OperationCallback, String, int, int) - Method in interface com.spotify.sdk.android.player.Player
Plays a single uri from specified index and specified position.
playUri(Player.OperationCallback, String, int, int) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Play a URI with the player.
positionMs - Variable in class com.spotify.sdk.android.player.PlaybackState
 
prevTrack - Variable in class com.spotify.sdk.android.player.Metadata
 

Q

queue(Player.OperationCallback, String) - Method in interface com.spotify.sdk.android.player.Player
Queue the track.
queue(Player.OperationCallback, String) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Add a URI to be played next in the queue.

R

refreshCache() - Method in interface com.spotify.sdk.android.player.Player
Triggers cache refresh and possible eviction of state data.
refreshCache() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
remove(int) - Method in class com.spotify.sdk.android.player.AudioRingBuffer
Removes items from the buffer.
removeConnectionStateCallback(ConnectionStateCallback) - Method in interface com.spotify.sdk.android.player.Player
 
removeConnectionStateCallback(ConnectionStateCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
removeNotificationCallback(Player.NotificationCallback) - Method in interface com.spotify.sdk.android.player.Player
 
removeNotificationCallback(Player.NotificationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
resume(Player.OperationCallback) - Method in interface com.spotify.sdk.android.player.Player
Resumes currently playing track.
resume(Player.OperationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Resume playback if paused.

S

seekToPosition(Player.OperationCallback, int) - Method in interface com.spotify.sdk.android.player.Player
Skips currently playing song to defined position.
seekToPosition(Player.OperationCallback, int) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Jump to a given position in the current track.
setAudioController(AudioController) - Method in class com.spotify.sdk.android.player.SpotifyPlayer.Builder
Sets a custom AudioController that will be used to intercept audio data.
setCallbackHandler(Handler) - Method in class com.spotify.sdk.android.player.SpotifyPlayer.Builder
Sets a custom callback handler that will be used to post all callbacks received by the player.
setConnectivityStatus(Player.OperationCallback, Connectivity) - Method in interface com.spotify.sdk.android.player.Player
Sends the information about current connectivity to native player.
setConnectivityStatus(Player.OperationCallback, Connectivity) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
The native SDK needs to be told what the current connection state is in order to determine ideal connection settings to Spotify's servers.
setPlaybackBitrate(Player.OperationCallback, PlaybackBitrate) - Method in interface com.spotify.sdk.android.player.Player
Set the bitrate of the player to specified value.
setPlaybackBitrate(Player.OperationCallback, PlaybackBitrate) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Set the bitrate of the player to specified value.
setRepeat(Player.OperationCallback, boolean) - Method in interface com.spotify.sdk.android.player.Player
Turns repeating on and off.
setRepeat(Player.OperationCallback, boolean) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Enable or disable repeat.
setShuffle(Player.OperationCallback, boolean) - Method in interface com.spotify.sdk.android.player.Player
Turns shuffling on and off.
setShuffle(Player.OperationCallback, boolean) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Enable or disable shuffling.
shouldUseCache() - Method in class com.spotify.sdk.android.player.Config
Check if disk cache is turned on.
shutdown() - Method in class com.spotify.sdk.android.player.SpotifyPlayer
 
skipToNext(Player.OperationCallback) - Method in interface com.spotify.sdk.android.player.Player
Skips to next track.
skipToNext(Player.OperationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Skip to the next track in the play queue.
skipToPrevious(Player.OperationCallback) - Method in interface com.spotify.sdk.android.player.Player
Skips to previous track.
skipToPrevious(Player.OperationCallback) - Method in class com.spotify.sdk.android.player.SpotifyPlayer
Skip to the previous track in the play queue.
SMARTPHONE - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Smartphone device
SPEAKER - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Device type for a Spotify Connect enabled speaker
Spotify - Class in com.spotify.sdk.android.player
The main "entry point" to the Spotify Android SDK.
SpotifyPlayer - Class in com.spotify.sdk.android.player
Basics
SpotifyPlayer.Builder - Class in com.spotify.sdk.android.player
Builder that can be used to create a customized instance of the SpotifyPlayer.
SpotifyPlayer.InitializationObserver - Interface in com.spotify.sdk.android.player
Observer interface used to know when the player is fully initialized.
start() - Method in interface com.spotify.sdk.android.player.AudioController
Called when the controller is initialized by the SpotifyPlayer.
STB - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Device type for a set-top box
stop() - Method in interface com.spotify.sdk.android.player.AudioController
Called when the controller is stopped by the SpotifyPlayer.

T

TABLET - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Tablet device
toString() - Method in class com.spotify.sdk.android.player.Metadata
 
toString() - Method in class com.spotify.sdk.android.player.Metadata.Track
 
toString() - Method in class com.spotify.sdk.android.player.PlaybackState
 
Track(String, String, String, String, String, String, long, long, String) - Constructor for class com.spotify.sdk.android.player.Metadata.Track
 
Track(Parcel) - Constructor for class com.spotify.sdk.android.player.Metadata.Track
 
TV - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Device type for a smart TV

U

uniqueId - Variable in class com.spotify.sdk.android.player.Config
Unique ID for the device.
UNKNOWN - Static variable in class com.spotify.sdk.android.player.Config.DeviceType
Unknown device type, only to be used if no other device types seem appropriate
uri - Variable in class com.spotify.sdk.android.player.Metadata.Track
 
useCache(boolean) - Method in class com.spotify.sdk.android.player.Config
Use disk cache.

V

valueOf(String) - Static method in enum com.spotify.sdk.android.player.Error
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.sdk.android.player.PlaybackBitrate
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.sdk.android.player.PlayerEvent
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.spotify.sdk.android.player.Error
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.sdk.android.player.PlaybackBitrate
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.sdk.android.player.PlayerEvent
Returns an array containing the constants of this enum type, in the order they are declared.

W

WIRED - Static variable in class com.spotify.sdk.android.player.Connectivity
The device is connected to a wired network (for example, ethernet)
WIRELESS - Static variable in class com.spotify.sdk.android.player.Connectivity
The device is connected to a high-speed wireless network (WiFi)
write(short[]) - Method in class com.spotify.sdk.android.player.AudioRingBuffer
Write samples to the buffer.
write(short[], int) - Method in class com.spotify.sdk.android.player.AudioRingBuffer
Write samples to the buffer.
writeToParcel(Parcel, int) - Method in class com.spotify.sdk.android.player.Metadata.Track
 
writeToParcel(Parcel, int) - Method in class com.spotify.sdk.android.player.Metadata
 
writeToParcel(Parcel, int) - Method in class com.spotify.sdk.android.player.PlaybackState
 
A B C D E F G H I L M N O P Q R S T U V W 
Skip navigation links
© Spotify AB, 2016. Terms of Use