GroupManagement service

Services related to groups

The GroupManagement 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.GroupManagementService.OneOfTheMethodsBelow({...})

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

1. AddMember
2. RemoveMember
3. ReportTrackBufferingResult
4. SetSourceAreaIds
5. GroupManagementService event

AddMember

const result = await sonos.GroupManagementService.AddMember({ MemberID:..., BootSeq:... });

Input object:

Output object:

RemoveMember

const result = await sonos.GroupManagementService.RemoveMember({ MemberID:... });

Input object:

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

ReportTrackBufferingResult

const result = await sonos.GroupManagementService.ReportTrackBufferingResult({ MemberID:..., ResultCode:... });

Input object:

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

SetSourceAreaIds

const result = await sonos.GroupManagementService.SetSourceAreaIds({ DesiredSourceAreaIds:... });

Input object:

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

GroupManagementService event

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

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