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

addToLibrary(String) - Method in interface com.spotify.android.appremote.api.UserApi
Adds item to users' library.
Album - Class in com.spotify.protocol.types
 
Album(String, String) - Constructor for class com.spotify.protocol.types.Album
 
album - Variable in class com.spotify.protocol.types.Track
The album of this track
ALL - Static variable in class com.spotify.protocol.types.Repeat
 
AppRemote - Interface in com.spotify.android.appremote.api
Interface specifying methods of App Remote API for connecting partner apps to Spotify app.
Artist - Class in com.spotify.protocol.types
 
Artist(String, String) - Constructor for class com.spotify.protocol.types.Artist
 
artist - Variable in class com.spotify.protocol.types.Track
The main artist of this track
artists - Variable in class com.spotify.protocol.types.Track
All artists of this track
AuthenticationFailedException - Exception in com.spotify.android.appremote.api.error
Indicates the client failed to authenticate with Spotify.
AuthenticationFailedException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.AuthenticationFailedException
 
authid - Variable in class com.spotify.protocol.types.HelloDetails
 
authmethods - Variable in class com.spotify.protocol.types.HelloDetails
 
AUTOMOTIVE - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
await() - Method in interface com.spotify.protocol.client.PendingResult
 
await(long, TimeUnit) - Method in interface com.spotify.protocol.client.PendingResult
 
await() - Method in class com.spotify.protocol.client.PendingResultBase
Block until a Result is available.
await(long, TimeUnit) - Method in class com.spotify.protocol.client.PendingResultBase
Block until a Result is received or in has expired.

B

broker - Variable in class com.spotify.protocol.types.Roles
 
build() - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
 
Builder(String) - Constructor for class com.spotify.android.appremote.api.ConnectionParams.Builder
 

C

call(String, S, Class<T>) - Method in interface com.spotify.android.appremote.api.AppRemote
 
call(String, S, Class<T>) - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
caller - Variable in class com.spotify.protocol.types.Roles
 
CallResult<T> - Class in com.spotify.protocol.client
Abstracts an asynchronous or future result of type T for a call
CallResult(Types.RequestId) - Constructor for class com.spotify.protocol.client.CallResult
 
CallResult.ResultCallback<T> - Interface in com.spotify.protocol.client
Callback for receiving the result once it is available
canAdd - Variable in class com.spotify.protocol.types.LibraryState
 
cancel() - Method in interface com.spotify.protocol.client.PendingResult
 
cancel() - Method in class com.spotify.protocol.client.PendingResultBase
Cancel this PendingResultBase to stop receiving callbacks.
cancel() - Method in class com.spotify.protocol.client.Subscription
 
canPlayOnDemand - Variable in class com.spotify.protocol.types.Capabilities
 
canRepeatContext - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
canRepeatTrack - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
canSeek - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
canSkipNext - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
canSkipPrev - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
canToggleShuffle - Variable in class com.spotify.protocol.types.PlayerRestrictions
 
Capabilities - Class in com.spotify.protocol.types
Capabilities of a user.
Capabilities(boolean) - Constructor for class com.spotify.protocol.types.Capabilities
 
category - Variable in class com.spotify.protocol.types.Info
 
ChildrenPageRequest - Class in com.spotify.protocol.types
 
ChildrenPageRequest(String, int, int) - Constructor for class com.spotify.protocol.types.ChildrenPageRequest
 
code - Variable in class com.spotify.protocol.types.UserStatus
 
com.spotify.android.appremote.api - package com.spotify.android.appremote.api
 
com.spotify.android.appremote.api.error - package com.spotify.android.appremote.api.error
 
com.spotify.protocol.client - package com.spotify.protocol.client
 
com.spotify.protocol.error - package com.spotify.protocol.error
 
com.spotify.protocol.types - package com.spotify.protocol.types
 
connect(Context, ConnectionParams, Connector.ConnectionListener) - Method in interface com.spotify.android.appremote.api.Connector
Connect to get an instance of SpotifyAppRemote
connect(Context, ConnectionParams, Connector.ConnectionListener) - Static method in class com.spotify.android.appremote.api.SpotifyAppRemote
Connect to get an instance of SpotifyAppRemote.
ConnectApi - Interface in com.spotify.android.appremote.api
Control on what device the Spotify App should be playing music Get an instance of a ConnectApi with SpotifyAppRemote.getConnectApi()
connectDecreaseVolume() - Method in interface com.spotify.android.appremote.api.ConnectApi
Decrease volume by a step size determined by Spotify Connect.
connectIncreaseVolume() - Method in interface com.spotify.android.appremote.api.ConnectApi
Increase volume by a step size determined by Spotify Connect.
ConnectionParams - Class in com.spotify.android.appremote.api
 
ConnectionParams.AuthMethod - Enum in com.spotify.android.appremote.api
 
ConnectionParams.Builder - Class in com.spotify.android.appremote.api
 
Connector - Interface in com.spotify.android.appremote.api
Use to connect to Spotify and retrieve an instance of SpotifyAppRemote
Connector.ConnectionListener - Interface in com.spotify.android.appremote.api
 
connectSetVolume(float) - Method in interface com.spotify.android.appremote.api.ConnectApi
Set a volume on the currently active device via Spotify Connect.
connectSwitchToLocalDevice() - Method in interface com.spotify.android.appremote.api.ConnectApi
Switch music to play on this (local) device, in case it is playing on another device (such as a computer) over Spotify Connect.
ContentApi - Interface in com.spotify.android.appremote.api
Get a list of content or start playback of a playable content item Get an instance of a ContentApi with SpotifyAppRemote.getContentApi()
ContentApi.ContentType - Interface in com.spotify.android.appremote.api
 
CouldNotFindSpotifyApp - Exception in com.spotify.android.appremote.api.error
A Spotify app that supports App Remote was not found on the device
CouldNotFindSpotifyApp() - Constructor for exception com.spotify.android.appremote.api.error.CouldNotFindSpotifyApp
 
CrossfadeState - Class in com.spotify.protocol.types
Represents the state of Spotify's audio crossfade setting.
CrossfadeState(boolean, int) - Constructor for class com.spotify.protocol.types.CrossfadeState
 

D

dealer - Variable in class com.spotify.protocol.types.Roles
 
DEFAULT - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
DEFAULT - Static variable in class com.spotify.protocol.types.PlayerOptions
 
DEFAULT - Static variable in class com.spotify.protocol.types.PlayerRestrictions
 
defaultImageHeight - Variable in class com.spotify.protocol.types.Info
 
defaultImageWidth - Variable in class com.spotify.protocol.types.Info
 
defaultThumbnailImageHeight - Variable in class com.spotify.protocol.types.Info
 
defaultThumbnailImageWidth - Variable in class com.spotify.protocol.types.Info
 
deliverError(Throwable) - Method in class com.spotify.protocol.client.PendingResultBase
 
deliverResult(Result<T>) - Method in class com.spotify.protocol.client.PendingResultBase
 
DETECTED - Static variable in class com.spotify.protocol.types.MotionState
 
DETECTING - Static variable in class com.spotify.protocol.types.MotionState
 
disconnect(SpotifyAppRemote) - Method in interface com.spotify.android.appremote.api.Connector
Disconnect a SpotifyAppRemote from the Spotify app and release resources
disconnect(SpotifyAppRemote) - Static method in class com.spotify.android.appremote.api.SpotifyAppRemote
Disconnect a SpotifyAppRemote from the Spotify app and release resources.
duration - Variable in class com.spotify.protocol.types.CrossfadeState
 
duration - Variable in class com.spotify.protocol.types.Track
Duration of the track in milliseconds

E

Empty - Class in com.spotify.protocol.types
Marks an empty (void) type
Empty() - Constructor for class com.spotify.protocol.types.Empty
 
equals(Object) - Method in class com.spotify.protocol.types.Album
 
equals(Object) - Method in class com.spotify.protocol.types.Artist
 
equals(Object) - Method in class com.spotify.protocol.types.Capabilities
 
equals(Object) - Method in class com.spotify.protocol.types.ChildrenPageRequest
 
equals(Object) - Method in class com.spotify.protocol.types.CrossfadeState
 
equals(Object) - Method in class com.spotify.protocol.types.HelloDetails
 
equals(Object) - Method in class com.spotify.protocol.types.Identifier
 
equals(Object) - Method in class com.spotify.protocol.types.Image
 
equals(Object) - Method in class com.spotify.protocol.types.ImageIdentifier
 
equals(Object) - Method in class com.spotify.protocol.types.ImageUri
 
equals(Object) - Method in class com.spotify.protocol.types.Info
 
equals(Object) - Method in class com.spotify.protocol.types.LibraryState
 
equals(Object) - Method in class com.spotify.protocol.types.ListItem
 
equals(Object) - Method in class com.spotify.protocol.types.ListItems
 
equals(Object) - Method in class com.spotify.protocol.types.Message
 
equals(Object) - Method in class com.spotify.protocol.types.MotionState
 
equals(Object) - Method in class com.spotify.protocol.types.PlaybackSpeed
 
equals(Object) - Method in class com.spotify.protocol.types.PlayerContext
 
equals(Object) - Method in class com.spotify.protocol.types.PlayerOptions
 
equals(Object) - Method in class com.spotify.protocol.types.PlayerRestrictions
 
equals(Object) - Method in class com.spotify.protocol.types.PlayerState
 
equals(Object) - Method in class com.spotify.protocol.types.Repeat
 
equals(Object) - Method in class com.spotify.protocol.types.Roles
 
equals(Object) - Method in class com.spotify.protocol.types.Shuffle
 
equals(Object) - Method in class com.spotify.protocol.types.Track
 
equals(Object) - Method in class com.spotify.protocol.types.Types.RequestId
 
equals(Object) - Method in class com.spotify.protocol.types.Types.SubscriptionId
 
equals(Object) - Method in class com.spotify.protocol.types.Uri
 
equals(Object) - Method in class com.spotify.protocol.types.Uris
 
equals(Object) - Method in class com.spotify.protocol.types.UriWithOptionExtras
 
equals(Object) - Method in class com.spotify.protocol.types.UserStatus
 
equals(Object) - Method in class com.spotify.protocol.types.VolumeState
 
equals(Object) - Method in class com.spotify.protocol.types.WelcomeDetails
 
ERROR - Static variable in class com.spotify.protocol.types.MotionState
 
extras - Variable in class com.spotify.protocol.types.HelloDetails
 

F

FITNESS - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
from(int) - Static method in class com.spotify.protocol.types.Types.RequestId
 
from(int) - Static method in class com.spotify.protocol.types.Types.SubscriptionId
 

G

getAuthMethod() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
getCapabilities() - Method in interface com.spotify.android.appremote.api.UserApi
Get the Capabilities of a current user.
getChildrenOfItem(ListItem, int, int) - Method in interface com.spotify.android.appremote.api.ContentApi
Get a list of child items of a browsable (non-playable) content item Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
getClientId() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
getConnectApi() - Method in interface com.spotify.android.appremote.api.AppRemote
 
getConnectApi() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
getContentApi() - Method in interface com.spotify.android.appremote.api.AppRemote
 
getContentApi() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
getCrossfadeState() - Method in interface com.spotify.android.appremote.api.PlayerApi
Returns the state of the audio crossfade setting.
getData() - Method in interface com.spotify.protocol.client.Result
 
getError() - Method in interface com.spotify.protocol.client.Result
 
getErrorMessage() - Method in interface com.spotify.protocol.client.Result
 
getImage(ImageUri) - Method in interface com.spotify.android.appremote.api.ImagesApi
Fetch an image from the Spotify app.
This method will call ImagesApi.getImage(ImageUri, Image.Dimension) with Image.Dimension#LARGE.
See Track.imageUri
See Image.Dimension
Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
getImage(ImageUri, Image.Dimension) - Method in interface com.spotify.android.appremote.api.ImagesApi
Fetch an image from the Spotify app and specify the preferred size by dimension.
See Track.imageUri
See Image.Dimension
Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
getImagesApi() - Method in interface com.spotify.android.appremote.api.AppRemote
 
getImagesApi() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
getJsonMapper() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
getLibraryState(String) - Method in interface com.spotify.android.appremote.api.UserApi
Gets library state for the given Spotify uri.
getPlayerApi() - Method in interface com.spotify.android.appremote.api.AppRemote
 
getPlayerApi() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
getPlayerState() - Method in interface com.spotify.android.appremote.api.PlayerApi
Get the player state of the Spotify app Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
getRaw() - Method in class com.spotify.protocol.types.Types.RequestId
 
getRaw() - Method in class com.spotify.protocol.types.Types.SubscriptionId
 
getRecommendedContentItems(String) - Method in interface com.spotify.android.appremote.api.ContentApi
Get a list of recommended content Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
GetRecommendedContentItemsRequest - Class in com.spotify.protocol.types
 
GetRecommendedContentItemsRequest() - Constructor for class com.spotify.protocol.types.GetRecommendedContentItemsRequest
 
GetRecommendedContentItemsRequest(String) - Constructor for class com.spotify.protocol.types.GetRecommendedContentItemsRequest
 
getRedirectUri() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
getRequestId() - Method in class com.spotify.protocol.client.CallResult
 
getRequestId() - Method in class com.spotify.protocol.client.Subscription
 
getRequiredFeatures() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
getUserApi() - Method in interface com.spotify.android.appremote.api.AppRemote
 
getUserApi() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
getValue() - Method in enum com.spotify.protocol.types.Image.Dimension
 
getValue() - Method in enum com.spotify.protocol.types.PlaybackSpeed.PodcastPlaybackSpeed
 

H

hasChildren - Variable in class com.spotify.protocol.types.ListItem
 
hashCode() - Method in class com.spotify.protocol.types.Album
 
hashCode() - Method in class com.spotify.protocol.types.Artist
 
hashCode() - Method in class com.spotify.protocol.types.Capabilities
 
hashCode() - Method in class com.spotify.protocol.types.ChildrenPageRequest
 
hashCode() - Method in class com.spotify.protocol.types.CrossfadeState
 
hashCode() - Method in class com.spotify.protocol.types.HelloDetails
 
hashCode() - Method in class com.spotify.protocol.types.Identifier
 
hashCode() - Method in class com.spotify.protocol.types.Image
 
hashCode() - Method in class com.spotify.protocol.types.ImageIdentifier
 
hashCode() - Method in class com.spotify.protocol.types.ImageUri
 
hashCode() - Method in class com.spotify.protocol.types.Info
 
hashCode() - Method in class com.spotify.protocol.types.LibraryState
 
hashCode() - Method in class com.spotify.protocol.types.ListItem
 
hashCode() - Method in class com.spotify.protocol.types.ListItems
 
hashCode() - Method in class com.spotify.protocol.types.Message
 
hashCode() - Method in class com.spotify.protocol.types.MotionState
 
hashCode() - Method in class com.spotify.protocol.types.PlaybackSpeed
 
hashCode() - Method in class com.spotify.protocol.types.PlayerContext
 
hashCode() - Method in class com.spotify.protocol.types.PlayerOptions
 
hashCode() - Method in class com.spotify.protocol.types.PlayerRestrictions
 
hashCode() - Method in class com.spotify.protocol.types.PlayerState
 
hashCode() - Method in class com.spotify.protocol.types.Repeat
 
hashCode() - Method in class com.spotify.protocol.types.Roles
 
hashCode() - Method in class com.spotify.protocol.types.Shuffle
 
hashCode() - Method in class com.spotify.protocol.types.Track
 
hashCode() - Method in class com.spotify.protocol.types.Types.RequestId
 
hashCode() - Method in class com.spotify.protocol.types.Types.SubscriptionId
 
hashCode() - Method in class com.spotify.protocol.types.Uri
 
hashCode() - Method in class com.spotify.protocol.types.Uris
 
hashCode() - Method in class com.spotify.protocol.types.UriWithOptionExtras
 
hashCode() - Method in class com.spotify.protocol.types.UserStatus
 
hashCode() - Method in class com.spotify.protocol.types.VolumeState
 
hashCode() - Method in class com.spotify.protocol.types.WelcomeDetails
 
height - Variable in class com.spotify.protocol.types.Image
 
height - Variable in class com.spotify.protocol.types.ImageIdentifier
 
HelloDetails - Class in com.spotify.protocol.types
 
HelloDetails(Roles, Info, String[], String, Map<String, String>) - Constructor for class com.spotify.protocol.types.HelloDetails
 

I

id - Variable in class com.spotify.protocol.types.Identifier
 
id - Variable in class com.spotify.protocol.types.ImageIdentifier
 
id - Variable in class com.spotify.protocol.types.Info
 
id - Variable in class com.spotify.protocol.types.ListItem
 
Identifier - Class in com.spotify.protocol.types
 
Identifier(String) - Constructor for class com.spotify.protocol.types.Identifier
 
Image - Class in com.spotify.protocol.types
 
Image(byte[], int, int) - Constructor for class com.spotify.protocol.types.Image
 
Image.Dimension - Enum in com.spotify.protocol.types
Predefined image dimensions.
The max value is Image.Dimension.LARGE with a value of 720px.
imageData - Variable in class com.spotify.protocol.types.Image
 
ImageIdentifier - Class in com.spotify.protocol.types
Identifier for image, other types uses Identifier.
ImageIdentifier is created with an uri String id and with a predefined Image.Dimension.
ImageIdentifier(String, Image.Dimension) - Constructor for class com.spotify.protocol.types.ImageIdentifier
 
ImagesApi - Interface in com.spotify.android.appremote.api
Get images from the Spotify App Get an instance of an ImagesApi with SpotifyAppRemote.getImagesApi().
imageType - Variable in class com.spotify.protocol.types.Info
 
ImageUri - Class in com.spotify.protocol.types
 
ImageUri(String) - Constructor for class com.spotify.protocol.types.ImageUri
 
imageUri - Variable in class com.spotify.protocol.types.ListItem
 
imageUri - Variable in class com.spotify.protocol.types.Track
Image id for this track.
info - Variable in class com.spotify.protocol.types.HelloDetails
 
Info - Class in com.spotify.protocol.types
 
Info(int, List<String>, String, String, String, String, String, String, int, int, int, int) - Constructor for class com.spotify.protocol.types.Info
 
INITIAL - Static variable in class com.spotify.protocol.types.MotionState
 
isAdded - Variable in class com.spotify.protocol.types.LibraryState
 
isCanceled() - Method in interface com.spotify.protocol.client.PendingResult
 
isCanceled() - Method in class com.spotify.protocol.client.PendingResultBase
 
isConnected() - Method in interface com.spotify.android.appremote.api.AppRemote
 
isConnected() - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
isDebugMode() - Static method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
isEnabled - Variable in class com.spotify.protocol.types.CrossfadeState
 
isEpisode - Variable in class com.spotify.protocol.types.Track
True if the track is a podcast, video show episode, or any other audio show episode, false otherwise.
isLoggedIn() - Method in class com.spotify.protocol.types.UserStatus
 
isPaused - Variable in class com.spotify.protocol.types.PlayerState
true if the state is paused i.e.
isPodcast - Variable in class com.spotify.protocol.types.Track
True if the track is a podcast, false otherwise.
isShuffling - Variable in class com.spotify.protocol.types.PlayerOptions
 
isSpotifyInstalled(Context) - Static method in class com.spotify.android.appremote.api.SpotifyAppRemote
Check if a Spotify app is installed on this device
isSuccessful() - Method in interface com.spotify.protocol.client.Result
 
Item - Interface in com.spotify.protocol.types
The interface all models should implement.
items - Variable in class com.spotify.protocol.types.ListItems
 

L

LibraryState - Class in com.spotify.protocol.types
 
LibraryState(String, boolean, boolean) - Constructor for class com.spotify.protocol.types.LibraryState
 
limit - Variable in class com.spotify.protocol.types.ChildrenPageRequest
 
limit - Variable in class com.spotify.protocol.types.ListItems
 
ListItem - Class in com.spotify.protocol.types
 
ListItem(String, String, ImageUri, String, String, boolean, boolean) - Constructor for class com.spotify.protocol.types.ListItem
 
ListItems - Class in com.spotify.protocol.types
 
ListItems(int, int, int, ListItem[]) - Constructor for class com.spotify.protocol.types.ListItems
 
longMessage - Variable in class com.spotify.protocol.types.UserStatus
 

M

Message - Class in com.spotify.protocol.types
 
Message(String) - Constructor for class com.spotify.protocol.types.Message
 
message - Variable in class com.spotify.protocol.types.Message
 
model - Variable in class com.spotify.protocol.types.Info
 
MotionState - Class in com.spotify.protocol.types
A motion state in the Spotify app.
MotionState(int) - Constructor for class com.spotify.protocol.types.MotionState
 
mVolume - Variable in class com.spotify.protocol.types.VolumeState
 

N

name - Variable in enum com.spotify.android.appremote.api.PlayerApi.StreamType
 
name - Variable in class com.spotify.protocol.types.Album
 
name - Variable in class com.spotify.protocol.types.Artist
 
name - Variable in class com.spotify.protocol.types.Info
 
name - Variable in class com.spotify.protocol.types.Track
The name (title) of this track
NAVIGATION - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
NONE - Static variable in class com.spotify.protocol.types.Types.RequestId
 
NONE - Static variable in class com.spotify.protocol.types.Types.SubscriptionId
 
NotLoggedInException - Exception in com.spotify.android.appremote.api.error
Indicates there is no active user session in Spotify that can authorize the request to connect.
NotLoggedInException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.NotLoggedInException
 

O

OFF - Static variable in class com.spotify.protocol.types.Repeat
 
OfflineModeException - Exception in com.spotify.android.appremote.api.error
Indicates the Spotify user has set their Spotify app to be in offline mode, but app remote requires a call to be made to the backend.
OfflineModeException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.OfflineModeException
 
offset - Variable in class com.spotify.protocol.types.ChildrenPageRequest
 
offset - Variable in class com.spotify.protocol.types.ListItems
 
onConnected(SpotifyAppRemote) - Method in interface com.spotify.android.appremote.api.Connector.ConnectionListener
Called when connection to the Spotify app has been established
ONE - Static variable in class com.spotify.protocol.types.Repeat
 
onEvent(T) - Method in interface com.spotify.protocol.client.Subscription.EventCallback
Called when the Subscription receives a new event
onFailure(Throwable) - Method in interface com.spotify.android.appremote.api.Connector.ConnectionListener
Called when connection to the Spotify app fails or is lost See CouldNotFindSpotifyApp com.spotify.android.appremote.api.error.LoggedOutException SpotifyConnectionTerminatedException
onResult(T) - Method in interface com.spotify.protocol.client.CallResult.ResultCallback
Called with the data of the result
onStart() - Method in interface com.spotify.protocol.client.Subscription.LifecycleCallback
Called when the Subscription starts
onStop() - Method in interface com.spotify.protocol.client.Subscription.LifecycleCallback
Called when the Subscription stops
options - Variable in class com.spotify.protocol.types.UriWithOptionExtras
 

P

parentId - Variable in class com.spotify.protocol.types.ChildrenPageRequest
 
pause() - Method in interface com.spotify.android.appremote.api.PlayerApi
Pause playback if it's currently playing Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
PendingResult<T> - Interface in com.spotify.protocol.client
 
PendingResultBase<T> - Class in com.spotify.protocol.client
 
PendingResultBase() - Constructor for class com.spotify.protocol.client.PendingResultBase
 
play(String) - Method in interface com.spotify.android.appremote.api.PlayerApi
Play the given Spotify uri.
play(String, PlayerApi.StreamType) - Method in interface com.spotify.android.appremote.api.PlayerApi
Play the given Spotify uri with specific behaviour for that streamtype - such as initiating playback of an URI on the audio stream for alarms.
playable - Variable in class com.spotify.protocol.types.ListItem
 
playbackOptions - Variable in class com.spotify.protocol.types.PlayerState
PlayerOptions for this player state
PlaybackPosition - Class in com.spotify.protocol.types
 
PlaybackPosition(long) - Constructor for class com.spotify.protocol.types.PlaybackPosition
 
playbackPosition - Variable in class com.spotify.protocol.types.PlayerState
playback position in milliseconds
playbackRestrictions - Variable in class com.spotify.protocol.types.PlayerState
PlayerRestrictions for this player state
PlaybackSpeed - Class in com.spotify.protocol.types
 
PlaybackSpeed(int) - Constructor for class com.spotify.protocol.types.PlaybackSpeed
 
playbackSpeed - Variable in class com.spotify.protocol.types.PlaybackSpeed
 
playbackSpeed - Variable in class com.spotify.protocol.types.PlayerState
Playback speed relative to wall time.
PlaybackSpeed.PodcastPlaybackSpeed - Enum in com.spotify.protocol.types
 
playContentItem(ListItem) - Method in interface com.spotify.android.appremote.api.ContentApi
Start playback of a playable ListItem Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
PlayerApi - Interface in com.spotify.android.appremote.api
Interact remotely with the Player of the Spotify app.
PlayerApi.StreamType - Enum in com.spotify.android.appremote.api
Available Streamtypes
PlayerContext - Class in com.spotify.protocol.types
The current context of the player - such as an album or a playlist - and its metadata
PlayerContext() - Constructor for class com.spotify.protocol.types.PlayerContext
 
PlayerContext(String, String, String, String) - Constructor for class com.spotify.protocol.types.PlayerContext
 
PlayerOptions - Class in com.spotify.protocol.types
 
PlayerOptions(boolean, int) - Constructor for class com.spotify.protocol.types.PlayerOptions
 
PlayerRestrictions - Class in com.spotify.protocol.types
 
PlayerRestrictions(boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.spotify.protocol.types.PlayerRestrictions
 
PlayerState - Class in com.spotify.protocol.types
A state of the player of the Spotify app.
PlayerState(Track, boolean, float, long, PlayerOptions, PlayerRestrictions) - Constructor for class com.spotify.protocol.types.PlayerState
 
position - Variable in class com.spotify.protocol.types.PlaybackPosition
 
protocolVersion - Variable in class com.spotify.protocol.types.Info
 

Q

queue(String) - Method in interface com.spotify.android.appremote.api.PlayerApi
Queue the given Spotify uri.

R

raw - Variable in class com.spotify.protocol.types.ImageUri
 
removeFromLibrary(String) - Method in interface com.spotify.android.appremote.api.UserApi
Removes item from users library.
Repeat - Class in com.spotify.protocol.types
 
Repeat(int) - Constructor for class com.spotify.protocol.types.Repeat
 
repeat - Variable in class com.spotify.protocol.types.Repeat
 
repeatMode - Variable in class com.spotify.protocol.types.PlayerOptions
 
requiredFeatures - Variable in class com.spotify.protocol.types.Info
 
Result<T> - Interface in com.spotify.protocol.client
 
resume() - Method in interface com.spotify.android.appremote.api.PlayerApi
Resume playback if it's currently paused Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
roles - Variable in class com.spotify.protocol.types.HelloDetails
 
Roles - Class in com.spotify.protocol.types
 
Roles() - Constructor for class com.spotify.protocol.types.Roles
 
Roles(Empty, Empty, Empty, Empty) - Constructor for class com.spotify.protocol.types.Roles
 
roles - Variable in class com.spotify.protocol.types.WelcomeDetails
 

S

seekTo(long) - Method in interface com.spotify.android.appremote.api.PlayerApi
Seek to specified position in the song.
seekToRelativePosition(long) - Method in interface com.spotify.android.appremote.api.PlayerApi
Seek to relative position in a track.
setAuthMethod(ConnectionParams.AuthMethod) - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
Use to override default authentication type ("appid")
setDebugMode(boolean) - Static method in class com.spotify.android.appremote.api.SpotifyAppRemote
Enable excessive logging.
setErrorCallback(ErrorCallback) - Method in interface com.spotify.protocol.client.PendingResult
 
setErrorCallback(ErrorCallback) - Method in class com.spotify.protocol.client.PendingResultBase
Set callback notified if this PendingResult fails
setEventCallback(Subscription.EventCallback<T>) - Method in class com.spotify.protocol.client.Subscription
Set callback called every time a new event is received on the Subscription
setJsonMapper(JsonMapper) - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
 
setLifecycleCallback(Subscription.LifecycleCallback) - Method in class com.spotify.protocol.client.Subscription
Set callback called when subscription starts and ends
setPodcastPlaybackSpeed(PlaybackSpeed.PodcastPlaybackSpeed) - Method in interface com.spotify.android.appremote.api.PlayerApi
Set playback speed for Podcast.
setRedirectUri(String) - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
Send redirect uri for authentication purposes.
setRepeat(int) - Method in interface com.spotify.android.appremote.api.PlayerApi
Set repeat mode to repeatMode Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
setRequiredFeatures(List<String>) - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
 
setResultCallback(CallResult.ResultCallback<T>) - Method in class com.spotify.protocol.client.CallResult
Set callback to receive the result data once it is available
setShuffle(boolean) - Method in interface com.spotify.android.appremote.api.PlayerApi
Set the shuffle state Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
shortMessage - Variable in class com.spotify.protocol.types.UserStatus
 
shouldShowAuthView() - Method in class com.spotify.android.appremote.api.ConnectionParams
 
showAuthView(boolean) - Method in class com.spotify.android.appremote.api.ConnectionParams.Builder
Spotify app will request user authorization UI if necessary.
Shuffle - Class in com.spotify.protocol.types
 
Shuffle(boolean) - Constructor for class com.spotify.protocol.types.Shuffle
 
shuffle - Variable in class com.spotify.protocol.types.Shuffle
 
skipNext() - Method in interface com.spotify.android.appremote.api.PlayerApi
Skip to the next track in the currently playing context if there is one.
SKIPPED - Static variable in class com.spotify.protocol.types.MotionState
 
skipPrevious() - Method in interface com.spotify.android.appremote.api.PlayerApi
Restart the current track or, if current track has played for less than 3 seconds, skip to the previous track in the currently playing context Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
skipToIndex(String, int) - Method in interface com.spotify.android.appremote.api.PlayerApi
Skip to track at specified index in album or playlist.
SLEEP - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
SpotifyAppRemote - Class in com.spotify.android.appremote.api
Entry point for interacting with the Spotify app using the Spotify App Remote for Android
SpotifyAppRemoteException - Exception in com.spotify.protocol.error
 
SpotifyAppRemoteException() - Constructor for exception com.spotify.protocol.error.SpotifyAppRemoteException
 
SpotifyAppRemoteException(String) - Constructor for exception com.spotify.protocol.error.SpotifyAppRemoteException
 
SpotifyAppRemoteException(Throwable) - Constructor for exception com.spotify.protocol.error.SpotifyAppRemoteException
 
SpotifyAppRemoteException(String, Throwable) - Constructor for exception com.spotify.protocol.error.SpotifyAppRemoteException
 
SpotifyConnectionTerminatedException - Exception in com.spotify.android.appremote.api.error
The connection to the Spotify app was terminated
SpotifyConnectionTerminatedException() - Constructor for exception com.spotify.android.appremote.api.error.SpotifyConnectionTerminatedException
 
SpotifyDisconnectedException - Exception in com.spotify.android.appremote.api.error
The Spotify app was/is disconnected
SpotifyDisconnectedException() - Constructor for exception com.spotify.android.appremote.api.error.SpotifyDisconnectedException
 
SpotifyRemoteServiceException - Exception in com.spotify.android.appremote.api.error
Encapsulates possible SecurityException and IllegalStateException errors thrown by Context.startService(Intent) and Context.startForegroundService(Intent).

SecurityException - If the caller does not have permission to access the service or the service can not be found.
IllegalStateException - If the application is in a state where the service can not be started, be found, or be accessed (such as not in the foreground in a state when services are allowed).
SpotifyRemoteServiceException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.SpotifyRemoteServiceException
 
state - Variable in class com.spotify.protocol.types.MotionState
The Motion state
STATUS_CODE_NOT_LOGGED_IN - Static variable in class com.spotify.protocol.types.UserStatus
 
STATUS_CODE_OK - Static variable in class com.spotify.protocol.types.UserStatus
 
subscribe(String, Class<T>) - Method in interface com.spotify.android.appremote.api.AppRemote
 
subscribe(String, Class<T>) - Method in class com.spotify.android.appremote.api.SpotifyAppRemote
 
subscriber - Variable in class com.spotify.protocol.types.Roles
 
subscribeToCapabilities() - Method in interface com.spotify.android.appremote.api.UserApi
Same as UserApi.getCapabilities(), but subscription.
subscribeToPlayerContext() - Method in interface com.spotify.android.appremote.api.PlayerApi
Create a subscription for player context changes
subscribeToPlayerState() - Method in interface com.spotify.android.appremote.api.PlayerApi
Create a subscription for player state changes Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
subscribeToUserStatus() - Method in interface com.spotify.android.appremote.api.UserApi
 
subscribeToVolumeState() - Method in interface com.spotify.android.appremote.api.ConnectApi
Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
Subscription<T> - Class in com.spotify.protocol.client
Track a subscription for data of type T Set callbacks for events and subscription lifecycle.
Subscription(Types.RequestId, RemoteClient) - Constructor for class com.spotify.protocol.client.Subscription
 
Subscription.EventCallback<T> - Interface in com.spotify.protocol.client
 
Subscription.LifecycleCallback - Interface in com.spotify.protocol.client
 
subtitle - Variable in class com.spotify.protocol.types.ListItem
 
subtitle - Variable in class com.spotify.protocol.types.PlayerContext
Subtitle of the current context

T

title - Variable in class com.spotify.protocol.types.ListItem
 
title - Variable in class com.spotify.protocol.types.PlayerContext
Title of the current context
toggleRepeat() - Method in interface com.spotify.android.appremote.api.PlayerApi
Toggle repeat mode Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
toggleShuffle() - Method in interface com.spotify.android.appremote.api.PlayerApi
Toggle the shuffle state Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
toString() - Method in class com.spotify.protocol.types.Album
 
toString() - Method in class com.spotify.protocol.types.Artist
 
toString() - Method in class com.spotify.protocol.types.Capabilities
 
toString() - Method in class com.spotify.protocol.types.ChildrenPageRequest
 
toString() - Method in class com.spotify.protocol.types.CrossfadeState
 
toString() - Method in class com.spotify.protocol.types.HelloDetails
 
toString() - Method in class com.spotify.protocol.types.Identifier
 
toString() - Method in class com.spotify.protocol.types.Image
 
toString() - Method in class com.spotify.protocol.types.ImageUri
 
toString() - Method in class com.spotify.protocol.types.Info
 
toString() - Method in class com.spotify.protocol.types.LibraryState
 
toString() - Method in class com.spotify.protocol.types.ListItem
 
toString() - Method in class com.spotify.protocol.types.ListItems
 
toString() - Method in class com.spotify.protocol.types.Message
 
toString() - Method in class com.spotify.protocol.types.MotionState
 
toString() - Method in class com.spotify.protocol.types.PlaybackSpeed
 
toString() - Method in class com.spotify.protocol.types.PlayerContext
 
toString() - Method in class com.spotify.protocol.types.PlayerOptions
 
toString() - Method in class com.spotify.protocol.types.PlayerRestrictions
 
toString() - Method in class com.spotify.protocol.types.PlayerState
 
toString() - Method in class com.spotify.protocol.types.Repeat
 
toString() - Method in class com.spotify.protocol.types.Roles
 
toString() - Method in class com.spotify.protocol.types.Shuffle
 
toString() - Method in class com.spotify.protocol.types.Track
 
toString() - Method in class com.spotify.protocol.types.Types.RequestId
 
toString() - Method in class com.spotify.protocol.types.Types.SubscriptionId
 
toString() - Method in class com.spotify.protocol.types.Uri
 
toString() - Method in class com.spotify.protocol.types.Uris
 
toString() - Method in class com.spotify.protocol.types.UriWithOptionExtras
 
toString() - Method in class com.spotify.protocol.types.UserStatus
 
toString() - Method in class com.spotify.protocol.types.WelcomeDetails
 
total - Variable in class com.spotify.protocol.types.ListItems
 
track - Variable in class com.spotify.protocol.types.PlayerState
A track currently associated with this player state or null if there is none
Track - Class in com.spotify.protocol.types
 
Track(Artist, List<Artist>, Album, long, String, String, ImageUri, boolean, boolean) - Constructor for class com.spotify.protocol.types.Track
 
type - Variable in class com.spotify.protocol.types.GetRecommendedContentItemsRequest
 
type - Variable in class com.spotify.protocol.types.PlayerContext
Type of player context
Types - Interface in com.spotify.protocol.types
 
Types.RequestId - Class in com.spotify.protocol.types
 
Types.SubscriptionId - Class in com.spotify.protocol.types
 

U

UNKNOWN - Static variable in class com.spotify.protocol.types.MotionState
 
UnsupportedFeatureVersionException - Exception in com.spotify.android.appremote.api.error
Indicates the feature set of the Spotify app and the current version of App Remote is not compatible.
UnsupportedFeatureVersionException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.UnsupportedFeatureVersionException
 
uri - Variable in class com.spotify.protocol.types.Album
 
uri - Variable in class com.spotify.protocol.types.Artist
 
uri - Variable in class com.spotify.protocol.types.LibraryState
 
uri - Variable in class com.spotify.protocol.types.ListItem
 
uri - Variable in class com.spotify.protocol.types.PlayerContext
The Spotify uri representing current player context.
uri - Variable in class com.spotify.protocol.types.Track
The Spotify track uri representing this track.
Uri - Class in com.spotify.protocol.types
 
Uri(String) - Constructor for class com.spotify.protocol.types.Uri
 
uri - Variable in class com.spotify.protocol.types.Uri
 
uri - Variable in class com.spotify.protocol.types.UriWithOptionExtras
 
Uris - Class in com.spotify.protocol.types
 
Uris() - Constructor for class com.spotify.protocol.types.Uris
 
Uris(String[]) - Constructor for class com.spotify.protocol.types.Uris
 
uris - Variable in class com.spotify.protocol.types.Uris
 
UriWithOptionExtras - Class in com.spotify.protocol.types
Enables request of playback of a uri with option extras, when playback of a URI needs to be bundled together with specific playback behavior that cannot be decoupled from the play command
UriWithOptionExtras() - Constructor for class com.spotify.protocol.types.UriWithOptionExtras
 
UriWithOptionExtras(String, String[]) - Constructor for class com.spotify.protocol.types.UriWithOptionExtras
 
UserApi - Interface in com.spotify.android.appremote.api
Get user-related data and perform actions related to current user Get an instance of an UserApi with SpotifyAppRemote.getUserApi().
UserNotAuthorizedException - Exception in com.spotify.android.appremote.api.error
Indicates the user has not/did not authorize this client of App Remote to use Spotify on the users behalf.
UserNotAuthorizedException(String, Throwable) - Constructor for exception com.spotify.android.appremote.api.error.UserNotAuthorizedException
 
UserStatus - Class in com.spotify.protocol.types
 
UserStatus(int, String, String) - Constructor for class com.spotify.protocol.types.UserStatus
 

V

valueOf(String) - Static method in enum com.spotify.android.appremote.api.ConnectionParams.AuthMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.android.appremote.api.PlayerApi.StreamType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.protocol.types.Image.Dimension
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.spotify.protocol.types.PlaybackSpeed.PodcastPlaybackSpeed
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.spotify.android.appremote.api.ConnectionParams.AuthMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.android.appremote.api.PlayerApi.StreamType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.protocol.types.Image.Dimension
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.spotify.protocol.types.PlaybackSpeed.PodcastPlaybackSpeed
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class com.spotify.protocol.types.Info
 
VolumeState - Class in com.spotify.protocol.types
The wrapper for current value of volume of active device over Spotify Connect.
VolumeState(float) - Constructor for class com.spotify.protocol.types.VolumeState
 

W

WAKE - Static variable in interface com.spotify.android.appremote.api.ContentApi.ContentType
 
WelcomeDetails - Class in com.spotify.protocol.types
 
WelcomeDetails(Roles) - Constructor for class com.spotify.protocol.types.WelcomeDetails
 
width - Variable in class com.spotify.protocol.types.Image
 
width - Variable in class com.spotify.protocol.types.ImageIdentifier
 
A B C D E F G H I L M N O P Q R S T U V W 
Skip navigation links