Marantz NR1609 HEOS CLI ProtocolSpecification Version 1.11 02072018 - Page 32

Search

Page 32 highlights

"name": "Artist", "scid": "'search_criteria_id'", "wildcard": "yes_or_no", }, { "name": "Album", "scid": "'search_criteria_id'", "wildcard": "yes_or_no", }, { "name": "Track", "scid": "'search_criteria_id'", "wildcard": "yes_or_no", "playable": "yes_or_no", "cid": "Prefix to search string", }, { "name": "Station", "scid": "'search_criteria_id'", "wildcard": "yes_or_no", } ] } Example: heos://browse/get_search_criteria?sid=3 Supported Sources: Local Media Servers, TuneIn, Rhapsody, Deezer, SiriusXM, Napster, Tidal, SoundCloud, Juke 4.4.6 Search Command: heos://browse/search?sid=source_id&search=search_string&scid=search_criteria&range=start#, end# Attribute Description sid Source id returned by 'get_music_sources' command search String for search limited to 128 unicode characters and may contain '*' for wildcard if supported by search criteria id scid Search criteria id returned by 'get_search_criteria' command 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). 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 50/100 records per response. The default maximum number of records depend on the service type. returned Number of items returned in current response Enumeration N/A N/A artist, album, song, station 0 - unknown >1 - valid count range starts from 0 N/A Response: Note: the following response provides examples of the various media types. The actual response will depend on the source searched and the results returned for the search string. { "heos": { "command": "browse/search", "result": "success", "message": "sid='source_id&scid='search_criteria_id'&range='start#, end#'&returned=items_in_current_response&count='total_items_available" }, "payload": [ { "container": "yes", "playable": "no", "type": "artist", "name": "'artist name'",

  • 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

"name": "Artist",
"scid": "'search_criteria_id'",
"wildcard": "yes_or_no",
},
{
"name": "Album",
"scid": "'search_criteria_id'",
"wildcard": "yes_or_no",
},
{
"name": "Track",
"scid": "'search_criteria_id'",
"wildcard": "yes_or_no",
"playable": "yes_or_no",
"cid": "Prefix to search string",
},
{
"name": "Station",
"scid": "'search_criteria_id'",
"wildcard": "yes_or_no",
}
]
}
Example: heos://browse/get_search_criteria?sid=3
Supported Sources: Local Media Servers, TuneIn, Rhapsody, Deezer, SiriusXM, Napster, Tidal, SoundCloud, Juke
4.4.6 Search
Command: heos://browse/search?sid=source_id&search=search_string&scid=search_criteria&range=start#, end#
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources' command
N/A
search
String for search limited to 128 unicode characters and may contain '*' for wildcard if supported by
search criteria id
N/A
scid
Search criteria id returned by 'get_search_criteria' command
artist, album, song,
station
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
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 50/100 records per response.
The default maximum number of records depend on the service type.
range starts from 0
returned
Number of items returned in current response
N/A
Response:
: the following response provides examples of the various media types. The actual response will depend on the source searched and
Note
the results returned for the search string.
{
"heos": {
"command": "browse/search",
"result": "success",
"message": "sid='source_id&scid='search_criteria_id'&range='start#,
end#'&returned=items_in_current_response&count='total_items_available"
},
"payload": [
{
"container": "yes",
"playable": "no",
"type": "artist",
"name": "'artist name'",