Marantz NR1609 HEOS CLI ProtocolSpecification Version 1.11 02072018 - Page 25

Browse Commands

Page 25 highlights

Response: { "heos": { "command": "group/ set_mute ", "result": "success", "message": "gid=group_id'&state='on_or_off'" } } Example: heos://group/set_mute?gid=1&state=off 4.3.10 Toggle Group Mute Command: heos://group/toggle_mute?gid=group_id Attribute Description Enumeration gid Group id returned by 'get_groups' command N/A Response: { "heos": { "command": "group/ toggle_mute ", "result": "success", "message": "gid=group_id" } } Example: heos://group/toggle_mute?gid=1 4.4 Browse Commands 4.4.1 Get Music Sources Attribute Description available Only valid for online music services. If true 'service_username' will provide user name of the service account. This should not be treated as the music service being supported through CLI or not. The services supported through CLI is listed in 'Supported music services' section. service_username Provides user name of the service account. Only avaialable for online music services when 'avaialble' field is set to true. Enumeration N/A N/A Command: heos://browse/get_music_sources Response: { "heos": { "command": "browse/get_music_sources", "result": "success", "message": "" }, "payload": [ { "name": "source name 1", "image_url": "source logo url 1", "type": "source type 1", "sid": source_id_1, "available": "true/false", "service_username": "user name of the service account" }, { "name": "source name 2",

  • 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

Response:
{
"heos": {
"command": "group/ set_mute ",
"result": "success",
"message": "gid=group_id'&state='on_or_off'"
}
}
Example: heos://group/set_mute?gid=1&state=off
4.3.10 Toggle Group Mute
Command: heos://group/toggle_mute?gid=group_id
Attribute
Description
Enumeration
gid
Group id returned by 'get_groups' command
N/A
Response:
{
"heos": {
"command": "group/ toggle_mute ",
"result": "success",
"message": "gid=group_id"
}
}
Example: heos://group/toggle_mute?gid=1
4.4 Browse Commands
4.4.1 Get Music Sources
Attribute
Description
Enumeration
available
Only valid for online music services. If true 'service_username' will provide user name of the service
account.
This should not be treated as the music service being supported through CLI or not.
The services supported through CLI is listed in 'Supported music services' section.
N/A
service_username
Provides user name of the service account.
Only avaialable for online music services when 'avaialble' field is set to true.
N/A
Command: heos://browse/get_music_sources
Response:
{
"heos": {
"command": "browse/get_music_sources",
"result": "success",
"message": ""
},
"payload": [
{
"name": "source name 1",
"image_url": "source logo url 1",
"type": "source type 1",
"sid": source_id_1,
"available": "true/false",
"service_username": "user name of the service account"
},
{
"name": "source name 2",