ContentDirectory service

Browse for local content

The ContentDirectory 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.

1. Available actions
   1. Browse
   2. CreateObject
   3. DestroyObject
   4. FindPrefix
   5. GetAlbumArtistDisplayOption
   6. GetAllPrefixLocations
   7. GetBrowseable
   8. GetLastIndexChange
   9. GetSearchCapabilities
   10. GetShareIndexInProgress
   11. GetSortCapabilities
   12. GetSystemUpdateID
   13. RefreshShareIndex
   14. RequestResort
   15. SetBrowseable
   16. UpdateObject
2. Events
   1. Subscribe to events
   2. Event variables
3. Custom errors

Service data

Sample request

POST /MediaServer/ContentDirectory/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:ContentDirectory: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

Browse

Browse for content: Music library (A), share(S:), Sonos playlists(SQ:), Sonos favorites(FV:2), radio stations(R:0/0), radio shows(R:0/1), queue(Q:)). Recommendation: Send one request, check the TotalMatches and - if necessary - do additional requests with higher StartingIndex. In case of duplicates only the first is returned! Example: albums with same title, even if artists are different

Action body:

<u:Browse xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <ObjectID>string</ObjectID>
  <BrowseFlag>string</BrowseFlag>
  <Filter>string</Filter>
  <StartingIndex>ui4</StartingIndex>
  <RequestedCount>ui4</RequestedCount>
  <SortCriteria>string</SortCriteria>
</u:Browse>

Inputs:

Outputs:

Remarks (1) If the title contains an apostrophe the returned uri will contain a '. (2) Some libraries support a BrowseAndParse, so you don’t have to parse the xml.

CreateObject

Action body:

<u:CreateObject xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <ContainerID>string</ContainerID>
  <Elements>string</Elements>
</u:CreateObject>

Inputs:

Outputs:

DestroyObject

Action body:

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

Inputs:

FindPrefix

Action body:

<u:FindPrefix xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <ObjectID>string</ObjectID>
  <Prefix>string</Prefix>
</u:FindPrefix>

Inputs:

Outputs:

GetAlbumArtistDisplayOption

Get the current album art display option such as WMP, ITUNES or NONE

Action body:

<u:GetAlbumArtistDisplayOption xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetAlbumArtistDisplayOption>

No input arguments

Outputs:

GetAllPrefixLocations

Action body:

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

Inputs:

Outputs:

GetBrowseable

Action body:

<u:GetBrowseable xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetBrowseable>

No input arguments

Outputs:

GetLastIndexChange

Action body:

<u:GetLastIndexChange xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetLastIndexChange>

No input arguments

Outputs:

GetSearchCapabilities

Action body:

<u:GetSearchCapabilities xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetSearchCapabilities>

No input arguments

Outputs:

GetShareIndexInProgress

Action body:

<u:GetShareIndexInProgress xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetShareIndexInProgress>

No input arguments

Outputs:

GetSortCapabilities

Action body:

<u:GetSortCapabilities xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetSortCapabilities>

No input arguments

Outputs:

GetSystemUpdateID

Action body:

<u:GetSystemUpdateID xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
</u:GetSystemUpdateID>

No input arguments

Outputs:

RefreshShareIndex

Updates the music library (share) index

Action body:

<u:RefreshShareIndex xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <AlbumArtistDisplayOption>string</AlbumArtistDisplayOption>
</u:RefreshShareIndex>

Inputs:

RequestResort

Action body:

<u:RequestResort xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <SortOrder>string</SortOrder>
</u:RequestResort>

Inputs:

SetBrowseable

Action body:

<u:SetBrowseable xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <Browseable>boolean</Browseable>
</u:SetBrowseable>

Inputs:

UpdateObject

Action body:

<u:UpdateObject xmlns:u="urn:schemas-upnp-org:service:ContentDirectory:1">
  <ObjectID>string</ObjectID>
  <CurrentTagValue>string</CurrentTagValue>
  <NewTagValue>string</NewTagValue>
</u:UpdateObject>

Inputs:

Events

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

Subscribe to events

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

Event variables

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

Custom errors

The ContentDirectoryService has the following known custom errors.

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