VirtualLineIn service
The VirtualLineIn service is available on these models: Sonos Play:1 (S1) S2
/ Sonos One (S13) S2
/ Sonos Beam (S14) S2
/ Sonos One (S18) S2
/ SYMFONISK Bookshelf (S21) S2
/ Sonos Roam (S27) S2
/ Sonos Play:3 (S3) S2
/ SYMFONISK Bookshelf (S33) S2
/ Sonos One SL (S38) S2
/ Sonos Play:5 (S6) S2
/ Sonos Playbar (S9) S2
/ Sonos Sub (Sub) S2
.
Service data
name | value |
---|---|
Control URL | http://192.168.x.x:1400/MediaRenderer/VirtualLineIn/Control |
Event subscription URL | http://192.168.x.x:1400/MediaRenderer/VirtualLineIn/Event |
Discovery URL | http://192.168.x.x:1400/xml/VirtualLineIn1.xml |
Service ID | urn:upnp-org:serviceId:VirtualLineIn |
Service type | urn:schemas-upnp-org:service:VirtualLineIn:1 |
Sample request
POST /MediaRenderer/VirtualLineIn/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:VirtualLineIn: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
Next
Action body:
<u:Next xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
</u:Next>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
Pause
Action body:
<u:Pause xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
</u:Pause>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
Play
Action body:
<u:Play xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
<Speed>string</Speed>
</u:Play>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
Speed | string | Â |
Previous
Action body:
<u:Previous xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
</u:Previous>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
SetVolume
Action body:
<u:SetVolume xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
<DesiredVolume>ui2</DesiredVolume>
</u:SetVolume>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
DesiredVolume | ui2 | Â |
StartTransmission
Action body:
<u:StartTransmission xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
<CoordinatorID>string</CoordinatorID>
</u:StartTransmission>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
CoordinatorID | string | Â |
Outputs:
parameter | type | description |
---|---|---|
CurrentTransportSettings | string | Â |
Stop
Action body:
<u:Stop xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
</u:Stop>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
StopTransmission
Action body:
<u:StopTransmission xmlns:u="urn:schemas-upnp-org:service:VirtualLineIn:1">
<InstanceID>ui4</InstanceID>
<CoordinatorID>string</CoordinatorID>
</u:StopTransmission>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | Â |
CoordinatorID | string | Â |
Events
The VirtualLineInService has variables that might be emitted if you subscribe to events.
Subscribe to events
SUBSCRIBE /MediaRenderer/VirtualLineIn/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600
Event variables
Variable | Sends events* | type | possible values |
---|---|---|---|
AVTransportURIMetaData | Â | string | Embedded XML |
CurrentTrackMetaData | ✔ | string | Embedded XML |
CurrentTransportActions | Â | string | Â |
EnqueuedTransportURIMetaData | Â | string | Embedded XML |
LastChange | ✔ | string |  |
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:1 (S1) | S2 | 77.4-49290 | 2024-02-13T15:56:06.184Z |
Sonos One (S13) | S2 | 63.2-90210 | 2021-07-21T23:31:19.273Z |
Sonos Beam (S14) | S2 | 64.3-19080 | 2021-08-18T06:04:08.308Z |
Sonos One (S18) | S2 | 77.4-49290 | 2024-02-13T15:55:36.464Z |
SYMFONISK Bookshelf (S21) | S2 | 66.4-23300 | 2022-01-01T11:41:01.361Z |
Sonos Roam (S27) | S2 | 63.2-90210 | 2021-07-21T23:31:31.207Z |
Sonos Play:3 (S3) | S2 | 64.3-19080 | 2021-08-18T06:09:36.692Z |
SYMFONISK Bookshelf (S33) | S2 | 77.4-49290 | 2024-02-13T15:55:24.423Z |
Sonos One SL (S38) | S2 | 72.2-40060 | 2023-05-22T16:39:25.503Z |
Sonos Play:5 (S6) | S2 | 64.3-19080 | 2021-08-18T06:06:35.970Z |
Sonos Playbar (S9) | S2 | 77.4-49290 | 2024-02-13T15:55:46.307Z |
Sonos Sub (Sub) | S2 | 63.2-90210 | 2021-07-21T23:31:40.304Z |