ClientPlayerApi

class ClientPlayerApi(api: GenericSpotifyApi) : SpotifyEndpoint

These endpoints allow for viewing and controlling user playback. Please view the official documentation for more information on how this works. This is in beta and is available for premium users only. Endpoints are not guaranteed to work and are subject to change!

Api Reference

Constructors

ClientPlayerApi

common

fun ClientPlayerApi(api: GenericSpotifyApi)

Types

PlayerRepeatState

common

enum PlayerRepeatState : Enum<ClientPlayerApi.PlayerRepeatState>

What state the player can repeat in.

Functions

equals

common

open operator fun equals(other: Any?): Boolean

getCurrentContext

common

suspend fun getCurrentContext(): CurrentlyPlayingContext?

Get information about the user’s current playback state, including track, track progress, and active device.

getCurrentlyPlaying

common

suspend fun getCurrentlyPlaying(): CurrentlyPlayingObject?

Get the object currently being played on the user’s Spotify account.

getDevices

common

suspend fun getDevices(): List<Device>

Get information about a user’s available devices.

getRecentlyPlayed

common

suspend fun getRecentlyPlayed(limit: Int? = api.spotifyApiOptions.defaultLimit, before: String? = null, after: String? = null): CursorBasedPagingObject<PlayHistory>

Get tracks from the current user’s recently played tracks.

hashCode

common

open fun hashCode(): Int

pause

common

suspend fun pause(deviceId: String? = null): String

Pause playback on the user’s account.

resume

common

suspend fun resume(deviceId: String? = null)

Resumes playback on the current device, if deviceId is not specified.

seek

common

suspend fun seek(positionMs: Long, deviceId: String? = null)

Seeks to the given position in the user’s currently playing track.

setRepeatMode

common

suspend fun setRepeatMode(state: ClientPlayerApi.PlayerRepeatState, deviceId: String? = null)

Set the repeat mode for the user’s playback.

setVolume

common

suspend fun setVolume(volume: Int, deviceId: String? = null)

Set the volume for the user’s current playback device.

skipBehind

common

suspend fun skipBehind(deviceId: String? = null): String

Skips to previous track in the user’s queue.

skipForward

common

suspend fun skipForward(deviceId: String? = null): String

Skips to the next track in the user’s queue.

startPlayback

common

suspend fun startPlayback(collection: CollectionUri? = null, offsetNum: Int? = null, offsetPlayableUri: PlayableUri? = null, deviceId: String? = null, playableUrisToPlay: List<PlayableUri> = emptyList())

Start or resume playback.

toggleShuffle

common

suspend fun toggleShuffle(shuffle: Boolean = true, deviceId: String? = null): String

Toggle shuffle on or off for user’s playback.

toString

common

open fun toString(): String

transferPlayback

common

suspend fun transferPlayback(deviceId: String, play: Boolean? = null)

Transfer playback to a new device and determine if it should start playing.

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

(source)