PlayerApi (Spotify App Remote)

```
public interface PlayerApi
```
Interact remotely with the Player of the Spotify app. Get an instance of a PlayerApi with SpotifyAppRemote.getPlayerApi().

See Also:

SpotifyAppRemote

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class PlayerApi.StreamType
Available Streamtypes

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PlayerApi.StreamType` Available Streamtypes

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CallResult<CrossfadeState>`	`getCrossfadeState()` Returns the state of the audio crossfade setting.
`CallResult<PlayerState>`	`getPlayerState()` Get the player state of the Spotify app Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`pause()` Pause playback if it's currently playing Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`play(java.lang.String uri)` Play the given Spotify uri.
`CallResult<Empty>`	`play(java.lang.String uri, PlayerApi.StreamType streamType)` Play the given Spotify uri with specific behaviour for that streamtype - such as initiating playback of an URI on the audio stream for alarms.
`CallResult<Empty>`	`queue(java.lang.String uri)` Queue the given Spotify uri.
`CallResult<Empty>`	`resume()` Resume playback if it's currently paused Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`seekTo(long positionMs)` Seek to specified position in the song.
`CallResult<Empty>`	`seekToRelativePosition(long milliseconds)` Seek to relative position in a track.
`CallResult<Empty>`	`setPodcastPlaybackSpeed(PlaybackSpeed.PodcastPlaybackSpeed podcastPlaybackSpeed)` Set playback speed for Podcast.
`CallResult<Empty>`	`setRepeat(int repeatMode)` Set repeat mode to repeatMode Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`setShuffle(boolean enabled)` Set the shuffle state Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`skipNext()` Skip to the next track in the currently playing context if there is one.
`CallResult<Empty>`	`skipPrevious()` 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`
`CallResult<Empty>`	`skipToIndex(java.lang.String uri, int index)` Skip to track at specified index in album or playlist.
`Subscription<PlayerContext>`	`subscribeToPlayerContext()` Create a subscription for player context changes
`Subscription<PlayerState>`	`subscribeToPlayerState()` Create a subscription for player state changes Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`toggleRepeat()` Toggle repeat mode Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`
`CallResult<Empty>`	`toggleShuffle()` Toggle the shuffle state Introduced in `com.spotify.protocol.client.RequiredFeatures#FEATURES_V1`

- Method Detail
  - play
```
CallResult<Empty> play(java.lang.String uri)
```
    Play the given Spotify uri. Supported uris currently include: Track - example: spotify:track:6rqhFgbbKwnb9MLmUQDhG6 Album - example: spotify:album:2VYSDvc0ZdcfkXDcYVjHs6 Artist - example: spotify:artist:4SJSGUVZ04tezaGrxc96EE Playlist - example: spotify:<user<:playlist::7hJSGUVZ04tevaGixc38EG
```
     NOTE Capabilities.canPlayOnDemand must be true to play a Track.
 
```
    Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    Parameters:
    
    uri - to play
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - play
```
CallResult<Empty> play(java.lang.String uri,
                       PlayerApi.StreamType streamType)
```
    Play the given Spotify uri with specific behaviour for that streamtype - such as initiating playback of an URI on the audio stream for alarms.
    Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
    
    Parameters:
    
    uri - to play
    
    streamType - Must be one of defined PlayerApi.StreamType
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - queue
```
CallResult<Empty> queue(java.lang.String uri)
```
    Queue the given Spotify uri. Supported uris currently include: Track - example: spotify:track:6rqhFgbbKwnb9MLmUQDhG6
    
    Parameters:
    
    uri - to queue
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - resume
```
CallResult<Empty> resume()
```
    Resume playback if it's currently paused Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - pause
```
CallResult<Empty> pause()
```
    Pause playback if it's currently playing Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - setPodcastPlaybackSpeed
```
CallResult<Empty> setPodcastPlaybackSpeed(PlaybackSpeed.PodcastPlaybackSpeed podcastPlaybackSpeed)
```
    Set playback speed for Podcast. See PlaybackSpeed Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
    
    Parameters:
    
    podcastPlaybackSpeed - predefined PlaybackSpeed.PodcastPlaybackSpeed values
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - skipNext
```
CallResult<Empty> skipNext()
```
    Skip to the next track in the currently playing context if there is one. Otherwise pause the context Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - skipPrevious
```
CallResult<Empty> skipPrevious()
```
    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
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - skipToIndex
```
CallResult<Empty> skipToIndex(java.lang.String uri,
                              int index)
```
    Skip to track at specified index in album or playlist.
    Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
    
    Parameters:
    
    uri - of album or playlist to play the track from.
    
    index - of track to be played. Index can have value 0 or higher. Negative values will be ignored.
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - setShuffle
```
CallResult<Empty> setShuffle(boolean enabled)
```
    Set the shuffle state Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Parameters:
    
    enabled - true enables shuffling, false turns it off
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - toggleShuffle
```
CallResult<Empty> toggleShuffle()
```
    Toggle the shuffle state Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - setRepeat
```
CallResult<Empty> setRepeat(int repeatMode)
```
    Set repeat mode to repeatMode Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Parameters:
    
    repeatMode - Must be one of OFF, ALL or ONE
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - toggleRepeat
```
CallResult<Empty> toggleRepeat()
```
    Toggle repeat mode Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - seekTo
```
CallResult<Empty> seekTo(long positionMs)
```
    Seek to specified position in the song. Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V2
    
    Parameters:
    
    positionMs - position to seek to
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - seekToRelativePosition
```
CallResult<Empty> seekToRelativePosition(long milliseconds)
```
    Seek to relative position in a track. Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V2
    
    Parameters:
    
    milliseconds - relative position to seek to
    
    Returns:
    
    a pending call result that can be used to track the success/failure of this command
  - getPlayerState
```
CallResult<PlayerState> getPlayerState()
```
    Get the player state of the Spotify app Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    a pending call result to get player state synchronously or asynchronously
  - subscribeToPlayerState
```
Subscription<PlayerState> subscribeToPlayerState()
```
    Create a subscription for player state changes Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1
    
    Returns:
    
    the subscription
  - subscribeToPlayerContext
```
Subscription<PlayerContext> subscribeToPlayerContext()
```
    Create a subscription for player context changes
    
    Returns:
    
    the subscription
  - getCrossfadeState
```
CallResult<CrossfadeState> getCrossfadeState()
```
    Returns the state of the audio crossfade setting. It includes whether it's enabled, and if so the crossfade duration.
    Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V3
    
    Returns:
    
    The object containing the state of crossfade.

Interface PlayerApi

Nested Class Summary

Method Summary

Method Detail

play

play

queue

resume

pause

setPodcastPlaybackSpeed

skipNext

skipPrevious

skipToIndex

setShuffle

toggleShuffle

setRepeat

toggleRepeat

seekTo

seekToRelativePosition

getPlayerState

subscribeToPlayerState

subscribeToPlayerContext

getCrossfadeState