Get Available Devices

PlayerGetDevicesResponse Me.Player.GetDevices(, )

GET/me/player/devices

Get information about a user’s available Spotify Connect devices. Some device models are not supported and will not be listed in the API response.

ParametersExpand Collapse

PlayerGetDevicesParams parameters

ReturnsExpand Collapse

class PlayerGetDevicesResponse:

required IReadOnlyList<DeviceObject> Devices

string? ID

The device ID. This ID is unique and persistent to some extent. However, this is not guaranteed and any cached device_id should periodically be cleared out and refetched as necessary.

Boolean IsActive

If this device is the currently active device.

Boolean IsPrivateSession

If this device is currently in a private session.

Boolean IsRestricted

Whether controlling this device is restricted. At present if this is "true" then no Web API commands will be accepted by this device.

string Name

A human-readable name for the device. Some devices have a name that the user can configure (e.g. "Loudest speaker") and some devices have a generic name associated with the manufacturer or device model.

Boolean Published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Boolean SupportsVolume

If this device can be used to set the volume.

string Type

Device type, such as "computer", "smartphone" or "speaker".

Long? VolumePercent

The current volume in percent.

minimum0

maximum100

Get Available Devices

PlayerGetDevicesParams parameters = new();

var response = await client.Me.Player.GetDevices(parameters);

Console.WriteLine(response);

{
  "devices": [
    {
      "id": "id",
      "is_active": true,
      "is_private_session": true,
      "is_restricted": true,
      "name": "Kitchen speaker",
      "published": true,
      "supports_volume": true,
      "type": "computer",
      "volume_percent": 59
    }
  ]
}

Returns Examples

{
  "devices": [
    {
      "id": "id",
      "is_active": true,
      "is_private_session": true,
      "is_restricted": true,
      "name": "Kitchen speaker",
      "published": true,
      "supports_volume": true,
      "type": "computer",
      "volume_percent": 59
    }
  ]
}