MusicServices service

Access to external music services, like Spotify or Youtube Music

The MusicServices 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.MusicServicesService.OneOfTheMethodsBelow({...})

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

1. GetSessionId
2. ListAvailableServices
3. UpdateAvailableServices
4. MusicServicesService event

GetSessionId

const result = await sonos.MusicServicesService.GetSessionId({ ServiceId:..., Username:... });

Input object:

Output object:

ListAvailableServices

Load music service list as xml

const result = await sonos.MusicServicesService.ListAvailableServices();

Output object:

Remarks Some libraries also support ListAndParseAvailableServices

UpdateAvailableServices

const result = await sonos.MusicServicesService.UpdateAvailableServices();

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

MusicServicesService event

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

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