SOsonos
playback

loadLineIn

Use the loadLineIn command in the playback namespace to change the current group source to the line-in source of a specified player. This can be be any player in the household that supports line-in. See Using Line-In on Sonos on the Sonos Support site for more details about the line-in capabilities of our players.

You can tell whether a player has line-in capabilities with the LINE_IN value in the capabilities object. See the groups object for details.

The player will switch away from the line-in source when the hardware detects that the user has physically unplugged the line-in cable.

post/groups/{groupId}/playback/lineIn

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/groups/{groupId}/playback/lineIn
  • 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

deviceIdstring nullable

(Optional) Represents the line-in source, any player in the household that supports line-in. The default value is the local playerId. This is the same as the player ID returned in the player object. Example: "RINCON_542A1BCC1A1001400"

playOnCompletionboolean nullable

(Optional) If true, start playback after loading the line-in source. If false, the player loads the cloud queue, but requires the play command to begin. If not provided, the default value is false.

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.