QueueService
Modify and browse queues
The QueueService is available on these models: v1-S1
/ v1-S5
/ v1-S9
.
Service data
name | value |
---|---|
Control URL | http://192.168.x.x:1400/MediaRenderer/Queue/Control |
Event subscription URL | http://192.168.x.x:1400/MediaRenderer/Queue/Event |
Discovery url | http://192.168.x.x:1400/xml/Queue1.xml |
Service ID | urn:sonos-com:serviceId:Queue |
Service type | urn:schemas-sonos-com:service:Queue:1 |
Sample request
POST /MediaRenderer/Queue/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-sonos-com:service:Queue: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
AddMultipleURIs
Action body:
<u:AddMultipleURIs xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<UpdateID>ui4</UpdateID>
<ContainerURI>string</ContainerURI>
<ContainerMetaData>string</ContainerMetaData>
<DesiredFirstTrackNumberEnqueued>ui4</DesiredFirstTrackNumberEnqueued>
<EnqueueAsNext>boolean</EnqueueAsNext>
<NumberOfURIs>ui4</NumberOfURIs>
<EnqueuedURIsAndMetaData>string</EnqueuedURIsAndMetaData>
</u:AddMultipleURIs>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
UpdateID | ui4 | |
ContainerURI | string | |
ContainerMetaData | string | |
DesiredFirstTrackNumberEnqueued | ui4 | |
EnqueueAsNext | boolean | |
NumberOfURIs | ui4 | |
EnqueuedURIsAndMetaData | string |
Outputs:
parameter | type | description |
---|---|---|
FirstTrackNumberEnqueued | ui4 | |
NumTracksAdded | ui4 | |
NewQueueLength | ui4 | |
NewUpdateID | ui4 |
AddURI
Action body:
<u:AddURI xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<UpdateID>ui4</UpdateID>
<EnqueuedURI>string</EnqueuedURI>
<EnqueuedURIMetaData>string</EnqueuedURIMetaData>
<DesiredFirstTrackNumberEnqueued>ui4</DesiredFirstTrackNumberEnqueued>
<EnqueueAsNext>boolean</EnqueueAsNext>
</u:AddURI>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
UpdateID | ui4 | |
EnqueuedURI | string | |
EnqueuedURIMetaData | string | |
DesiredFirstTrackNumberEnqueued | ui4 | |
EnqueueAsNext | boolean |
Outputs:
parameter | type | description |
---|---|---|
FirstTrackNumberEnqueued | ui4 | |
NumTracksAdded | ui4 | |
NewQueueLength | ui4 | |
NewUpdateID | ui4 |
AttachQueue
Action body:
<u:AttachQueue xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueOwnerID>string</QueueOwnerID>
</u:AttachQueue>
Inputs:
parameter | type | description |
---|---|---|
QueueOwnerID | string |
Outputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
QueueOwnerContext | string |
Backup
Action body:
<u:Backup xmlns:u="urn:schemas-sonos-com:service:Queue:1">
</u:Backup>
No input arguments
Browse
Action body:
<u:Browse xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<StartingIndex>ui4</StartingIndex>
<RequestedCount>ui4</RequestedCount>
</u:Browse>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
StartingIndex | ui4 | |
RequestedCount | ui4 |
Outputs:
parameter | type | description |
---|---|---|
Result | string | |
NumberReturned | ui4 | |
TotalMatches | ui4 | |
UpdateID | ui4 |
CreateQueue
Action body:
<u:CreateQueue xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueOwnerID>string</QueueOwnerID>
<QueueOwnerContext>string</QueueOwnerContext>
<QueuePolicy>string</QueuePolicy>
</u:CreateQueue>
Inputs:
parameter | type | description |
---|---|---|
QueueOwnerID | string | |
QueueOwnerContext | string | |
QueuePolicy | string |
Outputs:
parameter | type | description |
---|---|---|
QueueID | ui4 |
RemoveAllTracks
Action body:
<u:RemoveAllTracks xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<UpdateID>ui4</UpdateID>
</u:RemoveAllTracks>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
UpdateID | ui4 |
Outputs:
parameter | type | description |
---|---|---|
NewUpdateID | ui4 |
RemoveTrackRange
Action body:
<u:RemoveTrackRange xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<UpdateID>ui4</UpdateID>
<StartingIndex>ui4</StartingIndex>
<NumberOfTracks>ui4</NumberOfTracks>
</u:RemoveTrackRange>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
UpdateID | ui4 | |
StartingIndex | ui4 | |
NumberOfTracks | ui4 |
Outputs:
parameter | type | description |
---|---|---|
NewUpdateID | ui4 |
ReorderTracks
Action body:
<u:ReorderTracks xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<StartingIndex>ui4</StartingIndex>
<NumberOfTracks>ui4</NumberOfTracks>
<InsertBefore>ui4</InsertBefore>
<UpdateID>ui4</UpdateID>
</u:ReorderTracks>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
StartingIndex | ui4 | |
NumberOfTracks | ui4 | |
InsertBefore | ui4 | |
UpdateID | ui4 |
Outputs:
parameter | type | description |
---|---|---|
NewUpdateID | ui4 |
ReplaceAllTracks
Action body:
<u:ReplaceAllTracks xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<UpdateID>ui4</UpdateID>
<ContainerURI>string</ContainerURI>
<ContainerMetaData>string</ContainerMetaData>
<CurrentTrackIndex>ui4</CurrentTrackIndex>
<NewCurrentTrackIndices>string</NewCurrentTrackIndices>
<NumberOfURIs>ui4</NumberOfURIs>
<EnqueuedURIsAndMetaData>string</EnqueuedURIsAndMetaData>
</u:ReplaceAllTracks>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
UpdateID | ui4 | |
ContainerURI | string | |
ContainerMetaData | string | |
CurrentTrackIndex | ui4 | |
NewCurrentTrackIndices | string | |
NumberOfURIs | ui4 | |
EnqueuedURIsAndMetaData | string |
Outputs:
parameter | type | description |
---|---|---|
NewQueueLength | ui4 | |
NewUpdateID | ui4 |
SaveAsSonosPlaylist
Action body:
<u:SaveAsSonosPlaylist xmlns:u="urn:schemas-sonos-com:service:Queue:1">
<QueueID>ui4</QueueID>
<Title>string</Title>
<ObjectID>string</ObjectID>
</u:SaveAsSonosPlaylist>
Inputs:
parameter | type | description |
---|---|---|
QueueID | ui4 | |
Title | string | |
ObjectID | string |
Outputs:
parameter | type | description |
---|---|---|
AssignedObjectID | string |
Events
The QueueService has variables that might be emitted if you subscribe to events.
Subscribe to events
SUBSCRIBE /MediaRenderer/Queue/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600
Event variables
Variable | Sends events* | type | possible values |
---|---|---|---|
Curated | ❌ | boolean | |
LastChange | ✔ | string | |
UpdateID | ❌ | ui4 |
If the variable has a ✔
in the Sends events column, the service discovery specifies this variable emits events. A ❌
doesn’t mean that is won’t emit events.
This file is automatically generated with @svrooij/sonos-docs, do not edit manually.