Link Search Menu Expand Document
Sonos

ContentDirectoryService

Browse for local content

The ContentDirectoryService is available on these models: v1-S1 / v1-S5 / v1-S9.

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.ContentDirectoryService.OneOfTheMethodsBelow({...})

All actions that require input expect an object with the specified parameters, even if it only requires one parameter.

  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
  17. ContentDirectoryService event

Browse

Browse for content.

const result = await sonos.ContentDirectoryService.Browse({ ObjectID:..., BrowseFlag:..., Filter:..., StartingIndex:..., RequestedCount:..., SortCriteria:... });

Input object:

property type description
ObjectID string The search query, [‘A:ARTIST’,’A:ALBUMARTIST’,’A:ALBUM’,’A:GENRE’,’A:COMPOSER’,’A:TRACKS’,’A:PLAYLISTS’] with optionally ‘:search+query’ behind it.
BrowseFlag string How to browse Allowed values: BrowseMetadata / BrowseDirectChildren
Filter string Which fields should be returned ‘*’ for all.
StartingIndex number Paging, where to start
RequestedCount number Paging, number of items
SortCriteria string Sort the results based on metadata fields. ‘+upnp:artist,+dc:title’ for sorting on artist then on title.

Output object:

property type description
Result string  
NumberReturned number  
TotalMatches number  
UpdateID number  

Remarks Some libraries support a BrowseAndParse, so you don't have to parse the xml.

CreateObject 

const result = await sonos.ContentDirectoryService.CreateObject({ ContainerID:..., Elements:... });

Input object:

property type description
ContainerID string  
Elements string  

Output object:

property type description
ObjectID string  
Result string  

DestroyObject 

const result = await sonos.ContentDirectoryService.DestroyObject({ ObjectID:... });

Input object:

property type description
ObjectID string  

This actions returns a boolean whether or not the requests succeeded.

FindPrefix 

const result = await sonos.ContentDirectoryService.FindPrefix({ ObjectID:..., Prefix:... });

Input object:

property type description
ObjectID string  
Prefix string  

Output object:

property type description
StartingIndex number  
UpdateID number  

GetAlbumArtistDisplayOption 

const result = await sonos.ContentDirectoryService.GetAlbumArtistDisplayOption();

Output object:

property type description
AlbumArtistDisplayOption string  

GetAllPrefixLocations 

const result = await sonos.ContentDirectoryService.GetAllPrefixLocations({ ObjectID:... });

Input object:

property type description
ObjectID string  

Output object:

property type description
TotalPrefixes number  
PrefixAndIndexCSV string  
UpdateID number  

GetBrowseable 

const result = await sonos.ContentDirectoryService.GetBrowseable();

Output object:

property type description
IsBrowseable boolean  

GetLastIndexChange 

const result = await sonos.ContentDirectoryService.GetLastIndexChange();

Output object:

property type description
LastIndexChange string  

GetSearchCapabilities 

const result = await sonos.ContentDirectoryService.GetSearchCapabilities();

Output object:

property type description
SearchCaps string  

GetShareIndexInProgress 

const result = await sonos.ContentDirectoryService.GetShareIndexInProgress();

Output object:

property type description
IsIndexing boolean  

GetSortCapabilities 

const result = await sonos.ContentDirectoryService.GetSortCapabilities();

Output object:

property type description
SortCaps string  

GetSystemUpdateID 

const result = await sonos.ContentDirectoryService.GetSystemUpdateID();

Output object:

property type description
Id number  

RefreshShareIndex 

const result = await sonos.ContentDirectoryService.RefreshShareIndex({ AlbumArtistDisplayOption:... });

Input object:

property type description
AlbumArtistDisplayOption string  

This actions returns a boolean whether or not the requests succeeded.

RequestResort 

const result = await sonos.ContentDirectoryService.RequestResort({ SortOrder:... });

Input object:

property type description
SortOrder string  

This actions returns a boolean whether or not the requests succeeded.

SetBrowseable 

const result = await sonos.ContentDirectoryService.SetBrowseable({ Browseable:... });

Input object:

property type description
Browseable boolean  

This actions returns a boolean whether or not the requests succeeded.

UpdateObject 

const result = await sonos.ContentDirectoryService.UpdateObject({ ObjectID:..., CurrentTagValue:..., NewTagValue:... });

Input object:

property type description
ObjectID string  
CurrentTagValue string  
NewTagValue string  

This actions returns a boolean whether or not the requests succeeded.

ContentDirectoryService event 

const SonosDevice = require('@svrooij/sonos').SonosDevice
const sonos = new SonosDevice('192.168.x.x')
sonos.ContentDirectoryService.Events('serviceEvent', (data) => {
  console.log(data);
});

The ContentDirectoryService emits events with these properties. Not all properties are emitted every time.

parameter type possible values
Browseable boolean  
ContainerUpdateIDs string  
FavoritePresetsUpdateID string  
FavoritesUpdateID string  
RadioFavoritesUpdateID number  
RadioLocationUpdateID number  
RecentlyPlayedUpdateID string  
SavedQueuesUpdateID string  
SearchCapabilities string  
ShareIndexInProgress boolean  
ShareIndexLastError string  
ShareListUpdateID string  
SortCapabilities string  
SystemUpdateID number  
UserRadioUpdateID string  

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