Link Search Menu Expand Document

GroupManagementService

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

property type description
MemberID string  
BootSeq number  

Output object:

property type description
CurrentTransportSettings string  
CurrentURI string  
GroupUUIDJoined string  
ResetVolumeAfter boolean  
VolumeAVTransportURI string  

RemoveMember

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

Input object:

property type description
MemberID string  

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

ReportTrackBufferingResult

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

Input object:

property type description
MemberID string  
ResultCode number  

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

SetSourceAreaIds

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

Input object:

property type description
DesiredSourceAreaIds string  

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.

parameter type possible values
GroupCoordinatorIsLocal boolean  
LocalGroupUUID string  
ResetVolumeAfter boolean  
SourceAreaIds string  
VirtualLineInGroupID string  
VolumeAVTransportURI string  

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