transfer_my_playback: Transfer playback to a new device and determine if it should...

View source: R/player.R

transfer_my_playbackR Documentation

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

Description

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

Usage

transfer_my_playback(
  device_ids,
  play = FALSE,
  authorization = get_spotify_authorization_code()
)

Arguments

device_ids

Required. A character vector containing the ID of the device this on which playback should be started/transferred. Note: only a single device_id is currently supported.

play

Optional.
TRUE: Ensure playback happens on new device
FALSE (default): keep the current playback state
Note that a value of FALSE for the play parameter when also transferring to another device_id will not pause playback. To ensure that playback is paused on the new device you should send a pause command to the currently active device before transferring to the new device_id.

authorization

Required. A valid access token from the Spotify Accounts service. See the Web API authorization Guide for more details. Defaults to spotifyr::get_spotify_access_token(). The access token must have been issued on behalf of the current user.
The access token must have the user-modify-playback-state scope authorized in order to control playback.

Value

The response from the Spotify Web API on the PUT request, with a meaningful error message if the operation was not successful.

See Also

Other player functions: get_my_current_playback(), get_my_currently_playing(), get_my_devices(), get_my_recently_played(), pause_my_playback(), seek_to_position(), set_my_repeat_mode(), skip_my_playback(), skip_my_playback_previous(), start_my_playback(), toggle_my_shuffle()


spotifyr documentation built on Oct. 30, 2024, 9:13 a.m.