SOsonos
playerVolume

getVolume

Use the getVolume command in the playerVolume namespace to get the volume and mute state of a player.

get/players/{playerId}/playerVolume

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/players/{playerId}/playerVolume
  • Auth
    OAuth 2 and HTTP bearer and API key in header X-Sonos-Api-Key
    Authorization code: https://api.sonos.com/login/v3/oauth
    Token URL: https://api.sonos.com/login/v3/oauth/access scopes: playback-control-all

Response

Returns a playerVolume object type with the current volume, mute state, and fixed status of the targeted player.

volumeinteger required

Indicates the volume of the player, between 0 and 100.

mutedboolean

Indicates whether or not the player is muted. If true, the player is muted. If false, the player is not muted.

fixedboolean

Indicates whether or not the volume for the player is fixed or changeable. If true, your app cannot change the player volume. If false, your app can change the player volume. For example, the CONNECT has fixed-volume line-level output.

Changes

No recorded changes to this operation across all 1 revision of this API.