Marantz AV8805 HEOS CLI PROTOCOL Specification - Page 19

Group Commands

Page 19 highlights

Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A id Quick select Id whose source needs to be played 1-6 Response: { "heos": { } } "command": "player/play_quickselect", "result": "success", "message": "pid=player_id&id=" Example: heos://player/play_quickselect?pid=1&id=2 Currently supported HEOS products: LEGO AVR, HEOS BAR 4.2.25 Get QuickSelects [LS AVR Only] Command: heos://player/get_quickselects?pid=player_id Command: heos://player/get_quickselects?pid=player_id&id= Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A id Optional Id for which information is required. 1-6 By default information regarding all quick selects will be returned Response: { "heos": { "command": "player/get_quickselects", "result": "success", "message": "pid=player_id" }, "payload": [ { "id": 1, "name": "Quick Select 1'" }, { "id": 2, "name": "Quick Select 2 id": 6, "name": "Quick Select 6'" } ] } Example: heos://player/get_quickselects?pid=1 Currently supported HEOS products: LEGO AVR, HEOS BAR 4.3 Group Commands 4.3.1 Get Groups Command: heos://group/get_groups Response:

  • 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

Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
id
Quick select Id whose source needs to be played
1-6
Response:
{
"heos": {
"command": "player/play_quickselect",
"result": "success",
"message": "pid=player_id&id=<quick select id>"
}
}
Example: heos://player/play_quickselect?pid=1&id=2
Currently supported HEOS products: LEGO AVR, HEOS BAR
4.2.25 Get QuickSelects [LS AVR Only]
Command: heos://player/get_quickselects?pid=player_id
Command: heos://player/get_quickselects?pid=player_id&id=<quick select id>
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
id
Optional Id for which information is required.
By default information regarding all quick selects will be returned
1-6
Response:
{
"heos": {
"command": "player/get_quickselects",
"result": "success",
"message": "pid=player_id"
},
"payload": [
{
"id": 1,
"name": "Quick Select 1'"
},
{
"id": 2,
"name": "Quick Select 2'"
},
.
.
.
{
"id": 6,
"name": "Quick Select 6'"
}
]
}
Example: heos://player/get_quickselects?pid=1
Currently supported HEOS products: LEGO AVR, HEOS BAR
4.3 Group Commands
4.3.1 Get Groups
Command: heos://group/get_groups
Response: