Marantz NR1609 HEOS CLI ProtocolSpecification Version 1.11 02072018 - Page 27

Browse Source

Page 27 highlights

music_service heos_service heos_server dlna_server 4.4.3 Browse Source Command: heos://browse/browse?sid=source_id Attribute Description sid Source id returned by 'get_music_sources' command (Or) Source id returned by 'browse' command when browsing source types 'heos_server' and 'heos_service' id Options available for current browse level (options) scid criteria for creating new station 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. Enumeration N/A Following options are currently supported for 'Browse Source' command 13 - Create New Station (Pandora, iHeartRadio) 20 - Remove from HEOS Favorites (Favorites) Possibilities: 1 - Artist (default) (Criteria String: Create New Station by Artists) 5 - Show (Criteria String: Create New Station by Shows) 3 - Track (Criteria String: Create New Station by Tracks) 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'",

  • 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

music_service
heos_service
heos_server
dlna_server
4.4.3 Browse Source
Command: heos://browse/browse?sid=source_id
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources' command
(Or) Source id returned by 'browse' command when browsing
source types 'heos_server' and 'heos_service'
N/A
id
(options)
Options available for current browse level
Following options are currently supported for 'Browse
Source' command
13 - Create New Station (Pandora, iHeartRadio)
20 - Remove from HEOS Favorites (Favorites)
scid
criteria for creating new station
Possibilities:
1 - Artist (default) (Criteria String: Create New Station
by Artists)
5 - Show (
Create New Station by
Criteria String:
Shows)
3 - Track (
Create New Station by
Criteria String:
Tracks)
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'",