Marantz SR7011 HEOS_CLI_PROTOCOL_Specification_290616 - Page 33

Delete HEOS Playlist, 4.15 Get HEOS History, 4.16 Retrieve Album Metadata

Page 33 highlights

name String for new playlist name limited to 128 unicode characters N/A Response: { "heos": { } } "command": "browse/rename_playlist ", "result": "success", "message": "sid='source_id'&cid='contaiiner_id'&name='playlist_name'" Example: heos://browse/rename_playlist?sid=11&cid=234&name=new name 4.4.14 Delete HEOS Playlist Command: heos://browse/delete_playlist?sid=source_id&cid=contaiiner_id Attribute Description Enumeration sid Source id returned by 'get_music_sources' command; select HEOS source to get HEOS playlists. N/A cid Container id returned in 'Get HEOS Playlists' command N/A Response: Note: The HEOS History has two containers: one for songs and another for stations. The following response example is for the songs container. The station container returns the list of stations. { "heos": { "command": "browse/delete_playlist ", "result": "success", "message": "sid='source_id'&cid='contaiiner_id' } } Example: heos://browse/delete_playlist?sid=11&cid=234 4.4.15 Get HEOS History Refer to Browse Sources and Browse Source Containers 4.4.16 Retrieve Album Metadata Rhapsody and Napster services doesn't provide album art url while browsing for tracks. Controllers can use this command to retrieve album art url while browsing for tracks. Retrieve image url associated with a given album id. This command facilitates controllers to retrieve and update their UI with cover art, if image_url in browse/search/get_queue/get_now_playing_media command response is blank. Command: heos://browse/retrieve_metadata?sid=source_id&cid=album_id Attribute Description sid Source id returned by 'get_music_sources' command; select HEOS source to get HEOS playlists. cid Container id returned by 'browse' command or 'get_now_playing_media' command Comment Currently supported media sources are Rhapsody/Napster Rhapsody/Napster album ids Note: Supported music service is Rhapsody and Napster Response: { "heos": { "command": "browse/retrieve_metadata", "result": "success", "message": "sid=2&cid=album_id&returned=items_in_current_response&count=total_items_available" },

  • 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

name
String for new playlist name limited to 128 unicode characters
N/A
Response:
{
"heos": {
"command": "browse/rename_playlist ",
"result": "success",
"message": "sid='source_id'&cid='contaiiner_id'&name='playlist_name'"
}
}
Example: heos://browse/rename_playlist?sid=11&cid=234&name=new name
4.4.14 Delete HEOS Playlist
Command: heos://browse/delete_playlist?sid=source_id&cid=contaiiner_id
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources' command; select HEOS source to get HEOS playlists.
N/A
cid
Container id returned in 'Get HEOS Playlists' command
N/A
Response:
The HEOS History has two containers: one for songs and another for stations. The following response example is for the songs
Note:
container. The station container returns the list of stations.
{
"heos": {
"command": "browse/delete_playlist ",
"result": "success",
"message": "sid='source_id'&cid='contaiiner_id'
}
}
Example: heos://browse/delete_playlist?sid=11&cid=234
4.4.15 Get HEOS History
Refer to Browse Sources and Browse Source Containers
4.4.16 Retrieve Album Metadata
Rhapsody and Napster services doesn't provide album art url while browsing for tracks. Controllers can use this command to retrieve
album art url while browsing for tracks.
Retrieve image url associated with a given album id. This command facilitates controllers to retrieve and update their UI with cover art, if
image_url in browse/search/get_queue/get_now_playing_media command response is blank.
Command:
heos://browse/retrieve_metadata?sid=source_id&cid=album_id
Attribute
Description
Comment
sid
Source id returned by 'get_music_sources' command; select HEOS source
to get HEOS playlists.
Currently supported media sources are
Rhapsody/Napster
cid
Container id returned by 'browse' command or 'get_now_playing_media'
command
Rhapsody/Napster album ids
Note: Supported music service is Rhapsody and Napster
Response:
{
"heos": {
"command": "browse/retrieve_metadata",
"result": "success",
"message": "sid=2&cid=album_id&returned=items_in_current_response&count=total_items_available"
},