Introduced in Control API version 1.6.0.
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.
This command requires a
groupId to determine the target of the command. See the Control documentation for details.
See the table below for descriptions of parameters in the body.
||string||(Optional) Represents the line-in source, any player in the household that supports line-in. The default value is the local
||Boolean||(Optional) If true, start playback after loading the line-in source. If false, the player loads the cloud queue, but requires the
Returns an empty body with a
success value of true if successful. In the event of a failure, returns a
Sonos may return one of the following
globalError error codes.
||The specified line-in source does not have a line-in.|