Specifications
Table Of Contents
Example: heos://group/get_group_info&?gid=1
4.3.3 Set Group
This command is used to perform the following actions:
Create new group:
Creates new group. First player id in the list is group leader.
Ex: heos://group/set_group?pid=3,1,4
Modify existing group members:
Adds or delete players from the group. First player id should be the group leader id.
Ex: heos://group/set_group?pid=3,1,5
Ungroup all players in the group
Ungroup players. Player id (pid) should be the group leader id.
Ex: heos://group/set_group?pid=3
Command: heos://group/set_group?pid=player_id_leader, player_id_member_1,…,player_id_member_n
Attribute Description Enumeration
pid List of comma separated player_id's
where each player id is returned by
'get_players' or 'get_groups' command;
first player_id in list is group leader
N/A
Response:
The following response provides example when a group is created/modified.
{
"heos": {
"command": "player/set_group ",
"result": "success",
"message": "gid='new group_id'&name='group_name'&pid='player_id_1, player_id_2,…,player_id_n'
}
}
The following response provides example when all the speakers in the group are un-grouped.
{
"heos": {
"command": "player/set_group ",
"result": "success",
"message": "pid='player_id'
}
}
Example: heos://group/set_group?pid=3,1,4
4.3.4 Get Group Volume
Command: heos://group/get_volume?gid=group_id
Attribute Description Enumeration
gid Group id returned by 'get_groups' command N/A
Response: