Marantz AV7704 HEOS_CLI_ProtocolSpecification-Version-1.10_Dec2017 - Page 29

Browse Source Containers

Page 29 highlights

{ "id": 20, "name": "Remove from HEOS Favorites" } ] } ] } Example: heos://browse/browse?sid=1346442495 Supported Sources: Local Media Servers, Playlists, History, Aux-In, Favorites, TuneIn, Pandora, Rhapsody, Deezer, SiriusXM, iHeartRadio, Napster, Tidal, SoundCloud, Amazon Music, Juke 4.4.4 Browse Source Containers Command: heos://browse/browse?sid=source_id&cid=container_id&range=start#, end# Attribute Description sid Source id returned by 'get_music_sources' command cid Container id returned by 'browse' or 'search' command 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) Enumeration N/A N/A range starts from 0 0 - unknown >1 - valid count N/A Various options are presented as part of 'Browse Source container' command response. Supported options under each browse menu depends on service type and container type. Possible options under browse menu are listed below: 1 - Add Track to Library 2 - Add Album to Library 3 - Add Station to Library 4 - Add Playlist to Library 5 - Remove Track from Library 6 - Remove Album from Library 7 - Remove Station from Library 8 - Remove Playlist from Library 13 - Create New Station 19 - Add to HEOS Favorites 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.

  • 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

{
"id": 20,
"name": "Remove from HEOS Favorites"
}
]
}
]
}
Example: heos://browse/browse?sid=1346442495
Supported Sources: Local Media Servers, Playlists, History, Aux-In, Favorites, TuneIn, Pandora, Rhapsody, Deezer, SiriusXM, iHeartRadio,
Napster, Tidal, SoundCloud, Amazon Music, Juke
4.4.4 Browse Source Containers
Command: heos://browse/browse?sid=source_id&cid=container_id&range=start#, end#
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources' command
N/A
cid
Container id returned by 'browse' or 'search' command
N/A
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
Various options are presented as part of 'Browse
Source container' command response.
Supported options under each browse menu depends
on service type and container type.
Possible options under browse menu are listed below:
1 - Add Track to Library
2 - Add Album to Library
3 - Add Station to Library
4 - Add Playlist to Library
5 - Remove Track from Library
6 - Remove Album from Library
7 - Remove Station from Library
8 - Remove Playlist from Library
13 - Create New Station
19 - Add to HEOS Favorites
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"