Marantz AV7704 HEOS_CLI_ProtocolSpecification-Version-1.10_Dec2017 - Page 31

Get Source Search Criteria, 4.6 Search

Page 31 highlights

Example: heos://browse/browse?sid=2&cid=TopAlbums&range=0,100 Supported Sources: Local Media Servers, Playlists, History, Aux-In, TuneIn, Pandora, Rhapsody, Deezer, SiriusXM, iHeartRadio, Napster, Tidal, SoundCloud, Amazon Music, Juke 4.4.5 Get Source Search Criteria Command: heos://browse/get_search_criteria?sid=source_id Attribute Description Enumeration sid Source id returned by 'get_music_sources' command N/A playable Indicates if Play-All option is supported on searched tracks. yes or no cid Prefix to search string used while adding entire search results to play queue Currently supported prefix: Only valid when 'playable' is 'yes'. SEARCHED_TRACKS- Example command to play all tracked, searched with string 'earth': heos://browse/add_to_queue?pid=&sid=2&cid=SEARCHED_TRACKS-eart h&aid=1 Note: Can be extended, avoid hard code 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, Juke 4.4.6 Search Command: heos://browse/search?sid=source_id&search=search_string&scid=search_criteria&range=start#, end#

  • 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

Example: heos://browse/browse?sid=2&cid=TopAlbums&range=0,100
Supported Sources: Local Media Servers, Playlists, History, Aux-In, TuneIn, Pandora, Rhapsody, Deezer, SiriusXM, iHeartRadio,
Napster, Tidal, SoundCloud, Amazon Music, Juke
4.4.5 Get Source Search Criteria
Command: heos://browse/get_search_criteria?sid=source_id
Attribute
Description
Enumeration
sid
Source id returned by 'get_music_sources' command
N/A
playable
Indicates if Play-All option is supported on searched tracks.
yes or no
cid
Prefix to search string used while adding entire search results to play queue
Only valid when 'playable' is 'yes'.
Example command to play all tracked, searched with string 'earth':
heos://browse/add_to_queue?pid=<playerid>&sid=2&cid=SEARCHED_TRACKS-eart
&aid=1
h
Currently supported prefix:
SEARCHED_TRACKS-
Note: Can be extended, avoid hard
code
: 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, Juke
4.4.6 Search
Command: heos://browse/search?sid=source_id&search=search_string&scid=search_criteria&range=start#, end#