Marantz SR7011 HEOS_CLI_PROTOCOL_Specification_290616 - Page 24

command: browse/browse

Page 24 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. range starts from 0 NOTE: Range in Browse source command is only supported while browsing Favorites This command is used under two scenarios. Browsing actual media sources of type 'heos_server' and 'heos_service'. The command 'Get Music Sources' lists all music servers (type 'heos_server') in the network under one virtual source called 'Local Music'. Other virtual source that represents all auxiliary inputs (type 'heos_service') is 'AUX Input'. Browsing top music view. Results of this command depends on the music source selected. Note: Optionally this command returns service 'options' that are available for current browse items. Please refer to 'Get Service Options for now playing screen' for service options available on now playing screen. Note: The following response provides examples of the various service options. The actual response will depend on the service options available for a given source type. Response while browsing actual media sources of type 'heos_server' and 'heos_service'. These includes 'Local Music', 'History', 'AUX Inputs', 'Playlists', and 'Favorites'. { "heos": { "command": "browse/browse", "result": "success", "message": "sid=source_id&returned=items_in_current_response&count=total_items_available" }, "payload": [ { "name": "'source name 1'", "'image_url": "'source logo url 1'", "sid": "source id 1'", "type": "'source type 1'" }, { "name": "'source name 2'", "'image_url": "'source logo url 2'", "sid": "source id 2'", "type": "'source type 2'" }, { "name": "'source name N'", "'image_url": "'source logo url N'", "sid": "source id N'", "type": "'source type N'" } ], "options": [ { "browse": [ { "id": 13, "scid": "criteria Id", "name": "criteria string" } ] } ] } Example: heos://browse/browse?sid=1 Response when browsing top music view in an actual music server/music services. Note: the 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. { "heos": {

  • 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
NOTE: Range in Browse source command is only
supported while browsing Favorites
This command is used under two scenarios.
Browsing actual media sources of type 'heos_server' and 'heos_service'.
The command 'Get Music Sources' lists all music servers (type 'heos_server') in the network under one virtual source called 'Local
Music'. Other virtual source that represents all auxiliary inputs (type 'heos_service') is 'AUX Input'.
Browsing top music view.
Results of this command depends on the music source selected.
Note: Optionally this command returns service 'options' that are available for current browse items. Please refer to 'Get Service Options for
now playing screen' for service options available on now playing screen.
Note: The following response provides examples of the various service options. The actual response will depend on the service options
available for a given source type.
Response while browsing actual media sources of type 'heos_server' and 'heos_service'. These includes 'Local Music', 'History', 'AUX
Inputs', 'Playlists', and 'Favorites'.
{
"heos": {
"command": "browse/browse",
"result": "success",
"message": "sid=source_id&returned=items_in_current_response&count=total_items_available"
},
"payload": [
{
"name": "'source name 1'",
"'image_url": "'source logo url 1'",
"sid": "source id 1'",
"type": "'source type 1'"
},
{
"name": "'source name 2'",
"'image_url": "'source logo url 2'",
"sid": "source id 2'",
"type": "'source type 2'"
},
{
"name": "'source name N'",
"'image_url": "'source logo url N'",
"sid": "source id N'",
"type": "'source type N'"
}
],
"options": [
{
"browse": [
{
"id": 13,
"scid": "criteria Id",
"name": "criteria string"
}
]
}
]
}
Example: heos://browse/browse?sid=1
Response when browsing top music view in an actual music server/music services.
Note: the 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.
{
"heos": {