GroupRenderingControlService
Volume related controls for groups. Group volume is the average volume of all players. Snapshot stores the volume ratio between players.
The GroupRenderingControlService is available on these models: v1-S1
/ v1-S5
/ v1-S9
.
Service data
name | value |
---|---|
Control URL | http://192.168.x.x:1400/MediaRenderer/GroupRenderingControl/Control |
Event subscription URL | http://192.168.x.x:1400/MediaRenderer/GroupRenderingControl/Event |
Discovery url | http://192.168.x.x:1400/xml/GroupRenderingControl1.xml |
Service ID | urn:upnp-org:serviceId:GroupRenderingControl |
Service type | urn:schemas-upnp-org:service:GroupRenderingControl:1 |
Sample request
POST /MediaRenderer/GroupRenderingControl/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:GroupRenderingControl:1#{ActionName}"
Content-Type: text/xml; charset="utf-8"
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<s:Body>
{ActionBodyHere}
</s:Body>
</s:Envelope>
Available actions
GetGroupMute
Whether or not the group is muted.
Action body:
<u:GetGroupMute xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
</u:GetGroupMute>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
Outputs:
parameter | type | description |
---|---|---|
CurrentMute | boolean | Β |
Remarks Sould be send to coordinator only
GetGroupVolume
Get the group volume.
Action body:
<u:GetGroupVolume xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
</u:GetGroupVolume>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
Outputs:
parameter | type | description |
---|---|---|
CurrentVolume | ui2 | Β |
Remarks Sould be send to coordinator only
SetGroupMute
(Un-/)Mute the entire group
Action body:
<u:SetGroupMute xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
<DesiredMute>boolean</DesiredMute>
</u:SetGroupMute>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
DesiredMute | boolean | True for mute, false for un-mute |
Remarks Sould be send to coordinator only
SetGroupVolume
Change group volume. Players volume will be changed proportionally based on last snapshot
Action body:
<u:SetGroupVolume xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
<DesiredVolume>ui2</DesiredVolume>
</u:SetGroupVolume>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
DesiredVolume | ui2 | New volume between 0 and 100 |
Remarks Sould be send to coordinator only
SetRelativeGroupVolume
Relatively change group volume - returns final group volume. Players volume will be changed proportionally based on last snapshot
Action body:
<u:SetRelativeGroupVolume xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
<Adjustment>i4</Adjustment>
</u:SetRelativeGroupVolume>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
Adjustment | i4 | Number between -100 and +100 |
Outputs:
parameter | type | description |
---|---|---|
NewVolume | ui2 | Β |
Remarks Sould be send to coordinator only
SnapshotGroupVolume
Creates a new group volume snapshot, the volume ratio between all players. It is used by SetGroupVolume and SetRelativeGroupVolume
Action body:
<u:SnapshotGroupVolume xmlns:u="urn:schemas-upnp-org:service:GroupRenderingControl:1">
<InstanceID>ui4</InstanceID>
</u:SnapshotGroupVolume>
Inputs:
parameter | type | description |
---|---|---|
InstanceID | ui4 | InstanceID should always be 0 |
Remarks Sould be send to coordinator only
Events
The GroupRenderingControlService has variables that might be emitted if you subscribe to events.
Subscribe to events
SUBSCRIBE /MediaRenderer/GroupRenderingControl/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600
Event variables
Variable | Sends events* | type | possible values |
---|---|---|---|
GroupMute | β | boolean | Β |
GroupVolume | β | ui2 | Β |
GroupVolumeChangeable | β | boolean | Β |
If the variable has a β
in the Sends events column, the service discovery specifies this variable emits events. A β
doesnβt mean that is wonβt emit events.
Custom errors
The GroupRenderingControlService has the following known custom errors.
Error code | Description |
---|---|
701 | Player isn't the coordinator |
This file is automatically generated with @svrooij/sonos-docs, do not edit manually.