API Reference
Dev Portal

loadLineIn

post
{protocol}://api.ws.sonos.com/control/api/{version}/groups//playback/lineIn

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target groupId

Body Params
string | null

(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"

boolean | null

(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.

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses

Updated 23 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago