Link Search Menu Expand Document
Sonos API

VirtualLineIn service

The VirtualLineIn service is available on these models: 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 / Sonos Play:5 (S6) S2 / Sonos Sub (Sub) S2 / Sonos Play:1 (S1) S1 / Sonos Play:5 (S5) S1 / Sonos Playbar (S9) S1.

  1. Available actions
    1. Next
    2. Pause
    3. Play
    4. Previous
    5. SetVolume
    6. StartTransmission
    7. Stop
    8. StopTransmission
  2. Events
    1. Subscribe to events
    2. Event variables

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  
CurrentTrackMetaData   string  
CurrentTransportActions   string  
EnqueuedTransportURIMetaData   string  
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 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 68.3-30100 2022-06-26T09:03:01.959Z
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
Sonos Play:5 (S6) S2 64.3-19080 2021-08-18T06:06:35.970Z
Sonos Sub (Sub) S2 63.2-90210 2021-07-21T23:31:40.304Z
Sonos Play:1 (S1) S1 57.10-25140 2022-03-16T16:41:42.975Z
Sonos Play:5 (S5) S1 57.10-25140 2022-03-16T16:33:24.502Z
Sonos Playbar (S9) S1 57.10-25140 2022-03-16T16:41:37.730Z