Marantz AV8805 HEOS CLI PROTOCOL Specification - Page 17

Save Queue as Playlist, 2.19 Clear Queue, 2.20 Move Queue

Page 17 highlights

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 Command: heos://player/clear_queue?pid=player_id Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A Response: { "heos": { "command": "player/clear_queue ", "result": "success", "message": "pid='player_id'" } } Example: heos://player/clear_queue 4.2.20 Move Queue Command: heos://player/move_queue_item?pid=player_id&sqid=source_queue_id_1,source_queue_id_2,...,source_queue_id_n&dqid=d estination_queue_id Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A sqid List of comma separated queue_id's where each queue id for song is returned by 'get_queue' list item range:1 to size of command queue dqid User select this value as the destination of contents which is indicated in sqid. 1 to size of queue. Response: { "heos": { "command": "player/move_queue_item ", "result": "success", "message": "pid='player_id'&sqid='source_queue_id_1','source_queue_id_2',...,'source_queue_id_n',dqid='destination_queue _id' } }

  • 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

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
Command: heos://player/clear_queue?pid=player_id
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
Response:
{
"heos": {
"command": "player/clear_queue ",
"result": "success",
"message": "pid='player_id'"
}
}
Example: heos://player/clear_queue
4.2.20 Move Queue
Command:
id&sqid=source_queue_id_1,
&dqid=d
heos://player/move_queue_item?pid=player_
source_queue_id_2,...,source_queue_id_n
estination_queue_id
Attribute
Description
Enumeration
pid
Player id returned by 'get_players' or 'get_groups' command
N/A
sqid
List of comma separated queue_id's where each queue id for song is returned by 'get_queue'
command
list item range:1 to size of
queue
dqid
User select this value as the destination of contents which is indicated in sqid.
1 to size of queue.
Response:
{
"heos": {
"command": "player/move_queue_item ",
"result": "success",
"message": "pid='player_id'&sqid='
','
',...,'
',dqid='
source_queue_id_1
source_queue_id_2
source_queue_id_n
destination_queue
'
_id
}
}