Link Search Menu Expand Document
Sonos API

AudioIn service

Control line in

The AudioIn service is available on these models: Sonos Play:5 (S6) S2.

  1. Available actions
    1. GetAudioInputAttributes
    2. GetLineInLevel
    3. SelectAudio
    4. SetAudioInputAttributes
    5. SetLineInLevel
    6. StartTransmissionToGroup
    7. StopTransmissionToGroup
  2. Events
    1. Subscribe to events
    2. Event variables

Service data

name value
Control URL http://192.168.x.x:1400/AudioIn/Control
Event subscription URL http://192.168.x.x:1400/AudioIn/Event
Discovery URL http://192.168.x.x:1400/xml/AudioIn1.xml
Service ID urn:upnp-org:serviceId:AudioIn
Service type urn:schemas-upnp-org:service:AudioIn:1

Sample request 

POST /AudioIn/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:AudioIn:1#{ActionName}"
Content-Type: text/xml; charset="utf-8"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <s:Body>
    {ActionBodyHere}
  </s:Body>
</s:Envelope>

Available actions

GetAudioInputAttributes

Action body:

<u:GetAudioInputAttributes xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
</u:GetAudioInputAttributes>

No input arguments

Outputs:

parameter type description
CurrentName string  
CurrentIcon string  

GetLineInLevel

Action body:

<u:GetLineInLevel xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
</u:GetLineInLevel>

No input arguments

Outputs:

parameter type description
CurrentLeftLineInLevel i4  
CurrentRightLineInLevel i4  

SelectAudio

Action body:

<u:SelectAudio xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
  <ObjectID>string</ObjectID>
</u:SelectAudio>

Inputs:

parameter type description
ObjectID string  

SetAudioInputAttributes

Action body:

<u:SetAudioInputAttributes xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
  <DesiredName>string</DesiredName>
  <DesiredIcon>string</DesiredIcon>
</u:SetAudioInputAttributes>

Inputs:

parameter type description
DesiredName string  
DesiredIcon string  

SetLineInLevel

Action body:

<u:SetLineInLevel xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
  <DesiredLeftLineInLevel>i4</DesiredLeftLineInLevel>
  <DesiredRightLineInLevel>i4</DesiredRightLineInLevel>
</u:SetLineInLevel>

Inputs:

parameter type description
DesiredLeftLineInLevel i4  
DesiredRightLineInLevel i4  

StartTransmissionToGroup

Action body:

<u:StartTransmissionToGroup xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
  <CoordinatorID>string</CoordinatorID>
</u:StartTransmissionToGroup>

Inputs:

parameter type description
CoordinatorID string  

Outputs:

parameter type description
CurrentTransportSettings string  

StopTransmissionToGroup

Action body:

<u:StopTransmissionToGroup xmlns:u="urn:schemas-upnp-org:service:AudioIn:1">
  <CoordinatorID>string</CoordinatorID>
</u:StopTransmissionToGroup>

Inputs:

parameter type description
CoordinatorID string  

Events

The AudioInService has variables that might be emitted if you subscribe to events.

Subscribe to events 

SUBSCRIBE /AudioIn/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600

Event variables

Variable Sends events* type possible values
AudioInputName ✔ string  
Icon ✔ string  
LeftLineInLevel ✔ i4  
LineInConnected ✔ boolean 1 for true and 0 for false
Playing ✔ boolean 1 for true and 0 for false
RightLineInLevel ✔ i4  

If the variable has a ✔ in the Sends events column, the service discovery specifies this variable emits events. Other properties might be send as a part of LastChange

This file is automatically generated with @svrooij/sonos-docs, do not edit manually.

Device Software generation Software version Discovery date
Sonos Play:5 (S6) S2 64.3-19080 2021-08-18T06:06:35.970Z