SOsonos
playerVolume

duck

Ducking temporarily lowers the zone's volume without affecting the observed system volume. Sending another "duck" command to a system that is already ducking does not affect the output level. However, it does reset the duration.

post/players/{playerId}/playerVolume/duck

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/players/{playerId}/playerVolume/duck
  • 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

Request body

durationMillisinteger nullable

Ducking lasts for the specified time, unless explicitly ended with the "unduck" command. The default value is 3 seconds when this value is omitted. The minimum value is 0 seconds. The maximum value is 60 seconds. Values outside the valid range are clamped.

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).

Changes

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