ContentDirectory service

Browse for local content

The ContentDirectory service is available on these models: v2-S1 / v2-S13 / v2-S14 / v2-S18 / v2-S21 / v2-S27 / v2-S3 / v2-S33 / v2-S38 / v2-S6 / v2-S9 / v2-Sub.

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: 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

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

Input object:

Output object:

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

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

Input object:

Output object:

DestroyObject

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

Input object:

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

FindPrefix

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

Input object:

Output object:

GetAlbumArtistDisplayOption

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

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

Output object:

GetAllPrefixLocations

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

Input object:

Output object:

GetBrowseable

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

Output object:

GetLastIndexChange

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

Output object:

GetSearchCapabilities

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

Output object:

GetShareIndexInProgress

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

Output object:

GetSortCapabilities

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

Output object:

GetSystemUpdateID

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

Output object:

RefreshShareIndex

Updates the music library (share) index

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

Input object:

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

RequestResort

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

Input object:

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

SetBrowseable

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

Input object:

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

UpdateObject

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

Input object:

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.

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