Marantz SR5015 HEOS CLI ProtocolSpecification Version - Page 34

Search

Page 34 highlights

Example command to play all tracked, searched with string 'earth': heos://browse/add_to_queue? pid=&sid=2&cid=SEARCHED_T RACKS-earth&aid=1 Note: the following response provides examples of the various search criteria types. The actual response will depend on the source and the search types supported by that source. Response: { "heos": { "command": "browse/ get_search_criteria ", "result": "success", "message": "sid='source_id " }, "payload": [ { "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 4.4.6 Search Command: heos://browse/search?sid=source_id&search=search_string&scid=search_criteria&range=start#, end# Attribute sid search scid count Description Enumeration Source id returned by 'get_music_sources' N/A command String for search limited to 128 unicode N/A characters and may contain '*' for wildcard if supported by search criteria id Search criteria id returned by 'get_search_criteria' command artist, album, song, station 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

  • 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
  • 46
  • 47

Example command to play all tracked,
searched with string 'earth':
heos://browse/add_to_queue?
pid=<playerid>&sid=2&cid=SEARCHED_T
&aid=1
RACKS-
earth
: the following response provides examples of the various search criteria types. The actual response will depend on the source and
Note
the search types supported by that source.
Response:
{
"heos": {
"command": "browse/ get_search_criteria ",
"result": "success",
"message": "sid='source_id "
},
"payload": [
{
"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
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