Marantz SR5015 HEOS CLI ProtocolSpecification Version - Page 18

Remove Items from Queue, 2.18 Save Queue as Playlist, 2.19 Clear Queue

Page 18 highlights

pid Player id returned by 'get_players' or 'get_groups' command N/A qid Queue id for song returned by 'get_queue' command N/A Response: { "heos": { } } "command": " player/play_queue", "result": "success", "message": "pid='player_id'&qid='queue_id'" Example: heos://player/play_queue?pid=2&qid=9 4.2.17 Remove Item(s) from Queue Command: heos://player/remove_from_queue?pid=player_id&qid=queue_id_1,queue_id_2,...,queue_id_n Attribute pid qid Description Player id returned by 'get_players' or 'get_groups' command List of comma separated queue_id's where each queue id for song is returned by 'get_queue' command Enumeration N/A N/A Response: { "heos": { "command": "player/remove_from_queue ", "result": "success", "message": "pid='player_id'&qid=queue_id_1, queue_id_2,...,queue_id_n'" } } Example: heos://player/remove_from_queue? pid=1&qid=4,5,6 4.2.18 Save Queue as Playlist Command: heos://player/save_queue?pid=player_id&name=playlist_name Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A name String for new playlist name limited to 128 unicode characters N/A Response: { "heos": { "command": "player/save_queue ", "result": "success", "message": "pid='player_id'&name='playlist_name'" } } Example: heos://player/save_queue?pid=1&name=great playlist 4.2.19 Clear Queue

  • 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

pid
Player id returned by 'get_players' or 'get_groups' command
N/A
qid
Queue id for song returned by 'get_queue' command
N/A
Response:
{
"heos": {
"command": " player/play_queue",
"result": "success",
"message": "pid='player_id'&qid='queue_id'"
}
}
Example: heos://player/play_queue?pid=2&qid=9
4.2.17 Remove Item(s) from Queue
Command: heos://player/remove_from_queue?pid=player_id&qid=queue_id_1,queue_id_2,…,queue_id_n
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or
'get_groups' command
N/A
qid
List of comma separated queue_id's
where each queue id for song is returned
by 'get_queue' command
N/A
Response:
{
"heos": {
"command": "player/remove_from_queue ",
"result": "success",
"message": "pid='player_id'&qid=queue_id_1, queue_id_2,…,queue_id_n'"
}
}
Example: heos://player/remove_from_queue? pid=1&qid=4,5,6
4.2.18 Save Queue as Playlist
Command: heos://player/save_queue?pid=player_id&name=playlist_name
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
name
String for new playlist name limited to 128 unicode characters
N/A
Response:
{
"heos": {
"command": "player/save_queue ",
"result": "success",
"message": "pid='player_id'&name='playlist_name'"
}
}
Example: heos://player/save_queue?pid=1&name=great playlist
4.2.19 Clear Queue