Marantz SR5015 HEOS CLI ProtocolSpecification Version - Page 39

Add Track to Queue with Options

Page 39 highlights

sid Source id returned by 'get_music_sources' N/A command cid Container id returned by 'browse' or N/A 'search' command aid Add criteria id as defined by 1 - play now enumerations -> 2 - play next 3 - add to end 4 - replace and play pid Player id returned by 'get_players' or N/A 'get_groups' command Note: The cid for this command must be a 'playable' container type. Response: Note: this command will cause a Now Playing Change Event to occur if a new song is played. { "heos": { "command": " browse/add_to_queue", "result": "success", "message": "pid='player_id'&sid='source_id'&cid='container_id'&aid='add_criteria'" } } Example: heos://browse/add_to_queue?pid=1&sid=5&cid=Artist/All&aid=2 Supported Sources: Playable containers from Local Media Servers, Playlists, History, Rhapsody, Deezer, iHeartRadio, Napster, Tidal, SoundCloud. Also searched tracks as described in get_search_criteria command. 4.4.12 Add Track to Queue with Options Command: heos://browse/add_to_queue?pid=player_id&sid=source_id&cid=container_id&mid=media_id&aid=add-criteria Attribute sid cid mid aid pid Description Enumeration Source id returned by 'get_music_sources' N/A command Container id that is used to 'browse' or N/A 'search' current container Media id returned by 'browse' or 'search' N/A command Add criteria id as defined by enumerations -> 1 - play now 2 - play next 3 - add to end 4 - replace and play Player id returned by 'get_players' or N/A 'get_groups' command Note: The mid for this command must be a 'track' media type. Response: Note: this command will cause a Now Playing Change Event to occur if a new song is played. { "heos": { "command": " browse/add_to_queue", "result": "success", "message": "pid='player_id'&sid='source_id'&cid='container_id'&mid='media_id'&aid='add_criteria'" } } Example: heos://browse/add_to_queue?pid=1&sid=8&cid=Artists/All&mid=9&aid=1

  • 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

sid
Source id returned by 'get_music_sources'
command
N/A
cid
Container id returned by 'browse' or
'search' command
N/A
aid
Add criteria id as defined by
enumerations ->
1 – play now
2 – play next
3 – add to end
4 – replace and play
pid
Player id returned by 'get_players' or
'get_groups' command
N/A
Note: The cid for this command must be a 'playable' container type.
Response:
: this command will cause a Now Playing Change Event to occur if a new song is played.
Note
{
"heos": {
"command": " browse/add_to_queue",
"result": "success",
"message": "pid='player_id'&sid='source_id'&cid='container_id'&aid='add_criteria'"
}
}
Example: heos://browse/add_to_queue?pid=1&sid=5&cid=Artist/All&aid=2
Supported Sources: Playable containers from Local Media Servers, Playlists, History, Rhapsody, Deezer, iHeartRadio,
Napster, Tidal, SoundCloud. Also searched tracks as described in get_search_criteria command.
4.4.12 Add Track to Queue with Options
Command: heos://browse/add_to_queue?pid=player_id&sid=source_id&cid=container_id&mid=media_id&aid=add-criteria
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources'
command
N/A
cid
Container id that is used to 'browse' or
'search' current container
N/A
mid
Media id returned by 'browse' or 'search'
command
N/A
aid
Add criteria id as defined by
enumerations ->
1 – play now
2 – play next
3 – add to end
4 – replace and play
pid
Player id returned by 'get_players' or
'get_groups' command
N/A
Note: The mid for this command must be a 'track' media type.
Response:
: this command will cause a Now Playing Change Event to occur if a new song is played.
Note
{
"heos": {
"command": " browse/add_to_queue",
"result": "success",
"message": "pid='player_id'&sid='source_id'&cid='container_id'&mid='media_id'&aid='add_criteria'"
}
}
Example: heos://browse/add_to_queue?pid=1&sid=8&cid=Artists/All&mid=9&aid=1