Marantz SR5015 HEOS CLI ProtocolSpecification Version - Page 10

Player Commands

Page 10 highlights

Example: heos://system/prettify_json_response?enable=on 4.2 Player Commands 4.2.1 Get Players Command: heos://player/get_players Attribute pid gid network Description Player id pid of the Group leader Network connection type Enumeration N/A N/A wired wifi unknown (not applicable for external controllers) lineout control serial LineOut level type Only valid when lintout level type is Fixed (2). Only listed if device has valid serial number 1 - variable 2 - Fixed 1 - None 2 - IR 3 - Trigger 4 - Network N/A Note: The group id field (gid) is optional. The 'gid' field will only be appeared if the player(s) is part of a group. Note: control field is only populated when lineout level type is Fixed (lineout = 2) Response: { "heos": { "command": "player/get_players", "result": "success", "message": "" }, "payload": [ { "name": "'player name 1'", "pid": "player id 1'", "gid": "group id'", "model": "'player model 1'", "version": "'player verison 1'" "network": "wired" "lineout": "level type" "control": "control option" "serial": "serial number" }, { "name": "'player name 2'", "pid": "player id 2'", "gid": "group id'", "model": "'player model 2'", "version": "'player verison 2'" "network": "wifi" "lineout": "level type" "control": "control option" "serial": "serial number" }, .

  • 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
  • 46
  • 47

Example: heos://system/prettify_json_response?enable=on
4.2 Player Commands
4.2.1 Get Players
Command: heos://player/get_players
Attribute
Description
Enumeration
pid
Player id
N/A
gid
pid of the Group leader
N/A
network
Network connection type
wired
wifi
unknown (not applicable for external
controllers)
lineout
LineOut level type
1 - variable
2 - Fixed
control
Only valid when lintout level type is Fixed
(2).
1 - None
2 - IR
3 - Trigger
4 - Network
serial
Only listed if device has valid serial
number
N/A
Note: The group id field (gid) is optional. The 'gid' field will only be appeared if the player(s) is part of a group.
Note: control field is only populated when lineout level type is Fixed (lineout = 2)
Response:
{
"heos": {
"command": "player/get_players",
"result": "success",
"message": ""
},
"payload": [
{
"name": "'player name 1'",
"pid": "player id 1'",
"gid": "group id'",
"model": "'player model 1'",
"version": "'player verison 1'"
"network": "wired"
"lineout": "level type"
"control": "control option"
"serial": "serial number"
},
{
"name": "'player name 2'",
"pid": "player id 2'",
"gid": "group id'",
"model": "'player model 2'",
"version": "'player verison 2'"
"network": "wifi"
"lineout": "level type"
"control": "control option"
"serial": "serial number"
},
.