Marantz SR7011 HEOS_CLI_PROTOCOL_Specification_290616 - Page 14

Set Play Mode, 2.15 Get Queue

Page 14 highlights

"message": "pid='player_id'&&repeat=on_all_or_on_one_or_off&shuffle=on_or_off" } } Example: hoes://player/get_play_mode?pid=1 4.2.14 Set Play Mode Command: heos://player/set_play_mode?pid='player_id'&repeat=on_all_or_on_one_or_off&shuffle=on_or_off Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A repeat Player repeat state on_all, on_one, off shuffle Player shuffle state on, off Response: { "heos": { } } "command": " player/set_play_mode", "result": "success", "message": "pid='player_id'&repeat=on_all_or_on_one_or_off&shuffle=on_or_off" Example: heos://player/set_play_mode?pid=1&repeat=on_all&shuffle=off 4.2.15 Get Queue Command: heos://player/get_queue?pid=player_id&range=start#, end# Range is start and end record index to return. Range parameter is optional. Omitting range parameter returns all records but a maximum of 100 records are returned per response. Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A range Range is start and end record index to return. Range parameter is optional. range starts from 0 Omitting range parameter returns all records up to a maximum of 100 records per response. Response: { "heos": { "command": "player/get_queue", "result": "success", "message": "'pid=player_id&range=start#, end#" }, "payload": [ { "song": "'song name 1'", "album": "'album name 1'", "artist": "'artist name 1'", "image_url": "'image_url 1'", "qid": "'queue id 1'", "mid": "'media id 1'" "album_id": "AlbumId 1'" }, { "song": "'song name 2'", "album": "'album name 2'", "artist": "'artist name 2'", " image_url": "''image_url 2'", "qid": "'queue id 2'",

  • 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

"message": "pid='player_id'&&repeat=
_or_
_or_
&shuffle=
_or_
"
on_all
on_one
off
on
off
}
}
Example: hoes://player/get_play_mode?pid=1
4.2.14 Set Play Mode
Command: heos://player/set_play_mode?pid='player_id'&repeat=
_or_
_or_
&shuffle=
_or_
on_all
on_one
off
on
off
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
repeat
Player repeat state
on_all,
,
on_one off
shuffle
Player shuffle state
on, off
Response:
{
"heos": {
"command": " player/set_play_mode",
"result": "success",
"message": "pid='player_id'&repeat=
_or_
_or_
&shuffle=
"
on_all
on_one
off
on_or_off
}
}
Example: heos://player/set_play_mode?pid=1&repeat=on_all&shuffle=off
4.2.15 Get Queue
Command: heos://player/get_queue?pid=player_id&range=start#, end#
Range is start and end record index to return. Range parameter is optional. Omitting range parameter returns all records but a maximum
of 100 records are returned per response.
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
range
Range is start and end record index to return. Range parameter is optional.
Omitting range parameter returns all records up to a maximum of 100 records per response.
range starts from 0
Response:
{
"heos": {
"command": "player/get_queue",
"result": "success",
"message": "'pid=player_id&range=start#, end#"
},
"payload": [
{
"song": "'song name 1'",
"album": "'album name 1'",
"artist": "'artist name 1'",
"image_url": "'image_url 1'",
"qid": "'queue id 1'",
"mid": "'media id 1'"
"album_id": "AlbumId 1'"
},
{
"song": "'song name 2'",
"album": "'album name 2'",
"artist": "'artist name 2'",
" image_url": "''image_url 2'",
"qid": "'queue id 2'",