SOsonos
homeTheater

getOptions

This command retrieves the current home theater options.

get/players/{playerId}/homeTheater/options

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/players/{playerId}/homeTheater/options
  • 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 homeTheaterOptions object with a success value of true if successful. In the event of a failure, returns a globalError.

nightModeboolean nullable

Night Sound is most useful when watching TV at low volumes, such as late at night. It will make the dialogue more clear, while reducing the intensity of loud sounds.

enhanceDialogboolean nullable

Speech Enhancement boosts the audio frequencies associated with the human voice. Turning this feature on will make dialogue easier to hear, which can be especially useful during action movies.

Changes

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