spotify_ex v2.4.0

View Source Spotify.Player (spotify_ex v2.4.0)

Provides functions for retrieving and manipulating user's current playback.

https://developer.spotify.com/documentation/web-api/reference/player/

Link to this section Summary

Functions

build_response(body)
currently_playing_url(params \\ []) 
iex> Spotify.Player.currently_playing_url(market: "US")
"https://api.spotify.com/v1/me/player/currently-playing?market=US"
devices_url() 
iex> Spotify.Player.devices_url
"https://api.spotify.com/v1/me/player/devices"
enqueue(conn, uri, params \\ [])

Add an item to the user's playback queue. Spotify Documentation

enqueue_url(params \\ []) 
iex> Spotify.Player.enqueue_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/queue?device_id=abc"
get_current_playback(conn, params \\ [])

Get information about the user's playback currently playing context. Spotify Documentation

get_currently_playing(conn, params \\ [])

Get the user's currently playing tracks. Spotify Documentation

get_devices(conn)

Get the user's available devices. Spotify Documentation

get_recently_played(conn, params \\ [])

Get the user's recently played tracks. Spotify Documentation

handle_response(arg)
next_url(params \\ []) 
iex> Spotify.Player.next_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/next?device_id=abc"
pause(conn, params \\ [])

Pause the user's playback. Spotify Documentation

pause_url(params \\ []) 
iex> Spotify.Player.pause_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/pause?device_id=abc"
play(conn, params \\ [])

Start/resume the user's playback. Spotify Documentation

play_url(params \\ []) 
iex> Spotify.Player.play_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/play?device_id=abc"
player_url(params \\ []) 
iex> Spotify.Player.player_url(market: "US")
"https://api.spotify.com/v1/me/player?market=US"
previous_url(params \\ []) 
iex> Spotify.Player.previous_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/previous?device_id=abc"
recently_played_url(params \\ []) 
iex> Spotify.Player.recently_played_url(limit: 50)
"https://api.spotify.com/v1/me/player/recently-played?limit=50"
repeat_url(params \\ []) 
iex> Spotify.Player.repeat_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/repeat?device_id=abc"
seek(conn, position_ms, params \\ [])

Seek to position in currently playing track. Spotify Documentation

seek_url(params \\ []) 
iex> Spotify.Player.seek_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/seek?device_id=abc"
set_repeat(conn, state, params \\ [])

Set repeat mode for the user's playback. Spotify Documentation

set_shuffle(conn, state, params \\ [])

Toggle shuffle for the user's playback. Spotify Documentation

set_volume(conn, volume_percent, params \\ [])

Set volume for the user's playback. Spotify Documentation

shuffle_url(params \\ []) 
iex> Spotify.Player.shuffle_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/shuffle?device_id=abc"
skip_to_next(conn, params \\ [])

Skip the user's playback to next track. Spotify Documentation

skip_to_previous(conn, params \\ [])

Skip the user's playback to previous track. Spotify Documentation

transfer_playback(conn, device_ids, params \\ [])

Transfer the user's playback. Spotify Documentation

volume_url(params \\ []) 
iex> Spotify.Player.volume_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/volume?device_id=abc"

Link to this section Functions

Link to this function

build_response(body)

View Source
Link to this function

currently_playing_url(params \\ [])

View Source 
iex> Spotify.Player.currently_playing_url(market: "US")
"https://api.spotify.com/v1/me/player/currently-playing?market=US"
Link to this function

devices_url()

View Source 
iex> Spotify.Player.devices_url
"https://api.spotify.com/v1/me/player/devices"
Link to this function

enqueue(conn, uri, params \\ [])

View Source

Add an item to the user's playback queue. Spotify Documentation

Method: POST

Optional Params: device_id

Link to this function

enqueue_url(params \\ [])

View Source 
iex> Spotify.Player.enqueue_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/queue?device_id=abc"
Link to this function

get_current_playback(conn, params \\ [])

View Source

Get information about the user's playback currently playing context. Spotify Documentation

Method: GET

Optional Params: market, additional_types

Link to this function

get_currently_playing(conn, params \\ [])

View Source

Get the user's currently playing tracks. Spotify Documentation

Method: GET

Optional Params: market, additional_types

Link to this function

get_devices(conn)

View Source

Get the user's available devices. Spotify Documentation

Method: GET

Link to this function

get_recently_played(conn, params \\ [])

View Source

Get the user's recently played tracks. Spotify Documentation

Method: GET

Optional Params: limit, after, before

Link to this function

handle_response(arg)

View Source
Link to this function

next_url(params \\ [])

View Source 
iex> Spotify.Player.next_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/next?device_id=abc"
Link to this function

pause(conn, params \\ [])

View Source

Pause the user's playback. Spotify Documentation

Method: PUT

Optional Params: device_id

Link to this function

pause_url(params \\ [])

View Source 
iex> Spotify.Player.pause_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/pause?device_id=abc"
Link to this function

play(conn, params \\ [])

View Source

Start/resume the user's playback. Spotify Documentation

Method: PUT

Optional Params: device_id, context_uri, uris, offset, position_ms

Link to this function

play_url(params \\ [])

View Source 
iex> Spotify.Player.play_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/play?device_id=abc"
Link to this function

player_url(params \\ [])

View Source 
iex> Spotify.Player.player_url(market: "US")
"https://api.spotify.com/v1/me/player?market=US"
Link to this function

previous_url(params \\ [])

View Source 
iex> Spotify.Player.previous_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/previous?device_id=abc"
Link to this function

recently_played_url(params \\ [])

View Source 
iex> Spotify.Player.recently_played_url(limit: 50)
"https://api.spotify.com/v1/me/player/recently-played?limit=50"
Link to this function

repeat_url(params \\ [])

View Source 
iex> Spotify.Player.repeat_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/repeat?device_id=abc"
Link to this function

seek(conn, position_ms, params \\ [])

View Source

Seek to position in currently playing track. Spotify Documentation

Method: PUT

Optional Params: device_id

Link to this function

seek_url(params \\ [])

View Source 
iex> Spotify.Player.seek_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/seek?device_id=abc"
Link to this function

set_repeat(conn, state, params \\ [])

View Source

Set repeat mode for the user's playback. Spotify Documentation

Method: PUT

Optional Params: device_id

Link to this function

set_shuffle(conn, state, params \\ [])

View Source

Toggle shuffle for the user's playback. Spotify Documentation

Method: PUT

Optional Params: device_id

Link to this function

set_volume(conn, volume_percent, params \\ [])

View Source

Set volume for the user's playback. Spotify Documentation

Method: PUT

Optional Params: device_id

Link to this function

shuffle_url(params \\ [])

View Source 
iex> Spotify.Player.shuffle_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/shuffle?device_id=abc"
Link to this function

skip_to_next(conn, params \\ [])

View Source

Skip the user's playback to next track. Spotify Documentation

Method: POST

Optional Params: device_id

Link to this function

skip_to_previous(conn, params \\ [])

View Source

Skip the user's playback to previous track. Spotify Documentation

Method: POST

Optional Params: device_id

Link to this function

transfer_playback(conn, device_ids, params \\ [])

View Source

Transfer the user's playback. Spotify Documentation

Method: PUT

Optional Params: play

Link to this function

volume_url(params \\ [])

View Source 
iex> Spotify.Player.volume_url(device_id: "abc")
"https://api.spotify.com/v1/me/player/volume?device_id=abc"