Marantz AV7704 HEOS_CLI_ProtocolSpecification-Version-1.10_Dec2017 - Page 22

Set Group

Page 22 highlights

{ "heos": { "command": "player/get_groups", "result": "success", "message": "gid=group_id" }, "payload": { "name": "'group name 1'", "gid": "group id 1'", "players": [ { "name": "player name 1", "pid": "'player id 1'", "role": "player role 1 (leader or member)'" }, { "name": "player name 2", "pid": "'player id 2'", "role": "player role 2 (leader or member name": "player name N", "pid": "'player id N'", "role": "player role N (leader or member)'" } ] } } 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 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 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' Enumeration N/A

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45

{
"heos": {
"command": "player/get_groups",
"result": "success",
"message": "gid=group_id"
},
"payload": {
"name": "'group name 1'",
"gid": "group id 1'",
"players": [
{
"name": "player name 1",
"pid": "'player id 1'",
"role": "player role 1 (leader or member)'"
},
{
"name": "player name 2",
"pid": "'player id 2'",
"role": "player role 2 (leader or member)'"
},
.
.
.
{
"name": "player name N",
"pid": "'player id N'",
"role": "player role N (leader or member)'"
}
]
}
}
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'