Marantz SR7011 HEOS_CLI_PROTOCOL_Specification_290616 - Page 26

Add Station to Library Rhapsody

Page 26 highlights

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 either 50 or 100 records per response. The default maximum number of records depend on the service type. count Total number of items available in the container. NOTE: count value of '0' indicates unknown container size. Controllers needs to query until the return payload is empty (returned attribute is 0). returned Number of items returned in current response id Options available for current browse level (options) range starts from 0 0 - unknown >1 - valid count N/A Following options are currently supported for 'Browse Source container' command: 1 - Add Track to Library (Rhapsody) 2 - Add Album to Library (Rhapsody) 3 - Add Station to Library (Rhapsody) 4 - Add Playlist to Library (Rhapsody) 5 - Remove Track from Library (Rhapsody) 6 - Remove Album from Library (Rhapsody) 7 - Remove Station from Library (Rhapsody) 8 - Remove Playlist from Library (Rhapsody) 13 - Create New Station (Pandora) The following are valid media types: song station genre artist album container Note: A "yes" for the "container" field as well as the "playable" field implies that the container supports adding all media items to the play queue. Adding all media items of the container to the play queue is performed through "Add containers to queue"command. Note: Following response provides examples of the various media types. The actual response will depend on the source browsed and the hierarchy supported by that source. Response: { "heos": { "command": "browse/browse", "result": "success", "message": "sid='source_id&cid='container_id'&range='start,end'&returned=items_in_current_response&count=total_items_available" }, "payload": [ { "container": "yes", "playable": "no", "type": "artist", "name": "'artist name'", "image_url": "'artist image url'", "cid": "container id'", "mid": "media id" }, { "container": "yes", "playable": "yes", "type": "album", "name": "'album name'", "image_url": "'album image url'", "artist": "'artist name'", "cid": "'container 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

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 either
50 or 100 records per response.
The default maximum number of records depend on the service type.
range starts from 0
count
Total number of items available in the container.
NOTE: count value of '0' indicates unknown container size. Controllers
needs to query until the return payload
is empty (returned attribute is 0).
0 - unknown
>1 - valid count
returned
Number of items returned in current response
N/A
id
(options)
Options available for current browse level
Following options are currently supported for
'Browse Source container'
command:
1 - Add Track to Library (Rhapsody)
2 - Add Album to Library (Rhapsody)
3 - Add Station to Library (Rhapsody)
4 - Add Playlist to Library (Rhapsody)
5 - Remove Track from Library (Rhapsody)
6 - Remove Album from Library (Rhapsody)
7 - Remove Station from Library (Rhapsody)
8 - Remove Playlist from Library (Rhapsody)
13 - Create New Station (Pandora)
The following are valid media types:
song
station
genre
artist
album
container
Note: A "yes" for the "container" field as well as the "playable" field implies that the container supports adding all media items to the play
queue. Adding all media items of the container to the play queue is performed through
command.
"Add containers to queue"
Note: Following response provides examples of the various media types. The actual response will depend on the source browsed and the
hierarchy supported by that source.
Response:
{
"heos": {
"command": "browse/browse",
"result": "success",
"message":
"sid='source_id&cid='container_id'&range='start,end'&returned=items_in_current_response&count=total_items_available"
},
"payload": [
{
"container": "yes",
"playable": "no",
"type": "artist",
"name": "'artist name'",
"image_url": "'artist image url'",
"cid": "container id'",
"mid": "media id"
},
{
"container": "yes",
"playable": "yes",
"type": "album",
"name": "'album name'",
"image_url": "'album image url'",
"artist": "'artist name'",
"cid": "'container id'",