Marantz SR7011 HEOS_CLI_PROTOCOL_Specification_290616

Marantz SR7011 Manual

Get Marantz SR7011 PDF manuals and user guides View all Marantz SR7011 manuals
Add to My Manuals
Save this manual to your list of manuals

Marantz SR7011 manual content summary:

  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 1
    HEOS CLI Protocol Specification 1. Overview 1.1 Supported music services 2. Connection 2.1 Controller Design Guidelines 2.1.1 Driver Initialization 2.1.2 Caveats 2.1.2.1 Compatibility 2.1.2.2 Issues & Solutions 2.1.3 Miscellaneous 3. Command and Response Overview 3.1 Commands 3.2 Responses 4.
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 2
    1.280.96 Modifications Initial release. 1.1 1.304.61 Add set service option command. 1.2 1.310.170 Remove support for play url. Special characters ('&,'=', and '%') are encoded. 1.3 1.331.70 Add reboot command. Support Tidal/SoundCloud/Amazon Music Extend get_search_criteria to indicate
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 3
    commands and receives responses over Supported music services Supported online music services through CLI interface include Deezer, iHeartRadio, Napster, Pandora, Rhapsody, SoundCloud, SiriusXM, Tidal, TuneIn, Amazon Music. Other supported statically and manually programmed into the control set back to
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 4
    sent in the command. Please let us know if you need additional custom supported by HEOS speaker is 32. Service specific transport control options are as follows: Services Type Supported Transport Controls by CLI Supported Transport Controls in HEOS App (No significance. Only for Reference) Amazon
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 5
    on playing service NA NA Play, Pause, PlayNext, PlayPrevious *Depending on playing service Play, time, controllers use the same string that is received in previous command response. For example, while immediately, a special response will be sent back as shown below. This usually occurs during
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 6
    HEOS speaker does not send Change events. Controller needs to send this command with enable=on when it is ready to receive unsolicit responses from CLI. Please refer to "Driver Initialization" section regarding when to register for change events. Command: heos://system/register_for_change_events
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 7
    Example: heos://system/[email protected]&pw=12345 4.1.4 HEOS Account Sign Out Command: heos://system/sign_out Response: { "heos": { "command": "system/sign_out ", "result": "success", "message": "signed_out" } } Example: heos://system/sign_out 4.1.5 HEOS System Heart Beat Command: heos://
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 8
    4.2 Player Commands 4.2.1 Get Players Command: heos://player/get_players Attribute Description Enumeration pid Player id N/A gid pid of the Group leader N/A network Network connection type wired wifi lineout LineOut level type 1 - variable 2 - Fixed control Only valid when lintout
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 9
    ] } Example: heos://player/get_players 4.2.2 Get Player Info Command: heos://player/get_player_info?pid=player_id Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A gid pid of the Group leader N/A network Network connection type wired wifi
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 10
    ) Description Player id returned by 'get_players' or 'get_groups' command Options available for now playing media Enumeration N/A Following options are currently supported for now playing media 11 - Thumbs Up (Pandora) 12 - Thumbs Down (Pandora) 19 - Add station to HEOS Favorites Response: The
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 11
    The following response provides example when the speaker is playing a station. { "heos": { "command": "player/get_now_playing_media", "result": "success", "message": "pid='player_id'" }, "payload": { "type" : "'station'", "song": "'song name'", "station": "'station name'", "album": "'album name'", "
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 12
    "command": " player/ set_volume ", "result": "success", "message": "pid='player_id'&level='vol_level'" } } Example: heos://player/set_volume?pid=2&level=30 4.2.8 Volume Up Command: heos://player/volume_up?pid=player_id&step=step_level Attribute Description Enumeration pid Player id returned by
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 13
    "result": "success", "message": "pid='player_id'&state='on_or_off'" } } Example: heos://player/get_mute?pid=1 4.2.11 Set Mute Command: heos://player/set_mute?pid=player_id&state=on_or_off Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 14
    "message": "pid='player_id'&&repeat=on_all_or_on_one_or_off&shuffle=on_or_off" } } Example: hoes://player/get_play_mode?pid=1 4.2.14 Set Play Mode Command: heos://player/set_play_mode?pid='player_id'&repeat=on_all_or_on_one_or_off&shuffle=on_or_off Attribute Description Enumeration pid Player
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 15
    "qid": "'queue id 2'", "mid": "'media id 2'" "album_id": "AlbumId 2'" }, . . . { "song": "'song name N'", "album": "'album name N'", "artist": "'artist name N'", " image_url": "''image_url N'", "qid": "'queue id N'", "mid": "'media id N'" "album_id": "AlbumId N'" } ] } Example: heos://player/
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 16
    4.2.18 Save Queue as Playlist Command: heos://player/save_queue?pid=player_id&name=playlist_name Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A name String for new playlist name limited to 128 unicode characters N/A Response: { "heos": {
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 17
    Attribute Description Enumeration pid Player id returned by 'get_players' or 'get_groups' command N/A Response: { "heos": { } } "command": " player/play_previous", "result": "success", "message": "pid=player_id" Example: heos://player/play_previous?pid=1 4.3 Group Commands 4.3.1 Get Groups
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 18
    . { "name": "player name N", "pid": "'player id N'", "role": "player role N (leader or member name": "'group name N'", "gid": "group id N'", "players": [ { "name": "player name 1", "pid": "'player id 1'", "role": "player role 1 (leader or member)'" }, { "name": "player name 2", "pid": "'player id
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 19
    . . . { "name": "player name N", "pid": "'player id N'", "role": "player role N (leader or member)'" } ] } } Example: heos://group/get_group_info&?gid=1 4.3.3 Set Group This command is used to perform the following actions: Create new group: Creates new group. First player id in the list is group
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 20
    Attribute Description Enumeration gid Group id returned by 'get_groups' command N/A Response: { "heos": { "command": "group/get_volume ", "result": "success", "message": "gid='group_id'&level='vol_level'" } } Example: heos://group/get_volume?gid=1 4.3.5 Set Group Volume Command: heos://group/
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 21
    Attribute Description Enumeration gid Group id returned by 'get_groups' command N/A level Group volume step level 1 to 10(default 5) Response: { "heos": { "command": " group/ volume_down ", "result": "success", "message": "gid='group_id'&step='step_level'" } } Example: heos://group/
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 22
    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 Command: heos://
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 23
    Options available for current browse level (options) scid criteria for creating new station 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
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 24
    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
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 25
    mid": "'media id'" } ] } Example: heos://browse/browse?sid=1346442495 Supported Sources: Local Media Servers, Playlists, History, Aux-In, Favorites, TuneIn, , Deezer, SiriusXM, iHeartRadio, Napster, Tidal, SoundCloud, Amazon Music 4.4.4 Browse Source Containers Command: heos://browse/browse?
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 26
    per response. The default maximum number of records depend on the service type. count Total number of items available in the container. NOTE "container" field as well as the "playable" field implies that the container supports adding all media items to the play queue. Adding all media items of
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 27
    , Deezer, SiriusXM, iHeartRadio, Napster, Tidal, SoundCloud, Amazon Music 4.4.5 Get Source Search Criteria Command: heos://browse/ search string used while adding entire search results to play queue Currently supported prefix: Only valid when 'playable' is 'yes'. SEARCHED_TRACKS- Example
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 28
    128 unicode characters and may contain '*' for wildcard if supported by search criteria id scid Search criteria id returned 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
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 29
    "name": "'station name'", "image_url": "'station url'", "mid": "'media id'" } ] } Example: heos://browse/search?sid=2&search="U2"&scid=1 Supported Sources: Local Media Servers, TuneIn, Rhapsody, Deezer, Napster, Tidal, SoundCloud 4.4.7 Play Station Command: heos://browse/play_stream?pid=player_id
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 30
    Example: heos://browse/play_stream?pid=1&sid=2&cid='CID-55'&mid=15376&name=Q95 Supported Sources: History, Favorites, TuneIn, Pandora, Rhapsody, Deezer, SiriusXM, iHeartRadio, Napster, Tidal, SoundCloud, Amazon Music 4.4.8 Play Preset Station Command: heos://browse/play_preset?pid=player_id&preset
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 31
    input input source name Note: Validity of Inputs depends on the type of source HEOS device "inputs/aux_in_1" "inputs/aux1" "inputs/aux2" "inputs/aux3" "inputs/aux4" "inputs/aux5" "inputs/aux6" "inputs/aux7" "inputs/line_in_1" "inputs/line_in_2" "inputs/line_in_3" "inputs/line_in_4" "inputs/
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 32
    } Example: heos://browse/add_to_queue?pid=1&sid=8&cid=Artists/All&mid=9&aid=1 Supported Sources: Local Media Servers, Playlists, History, Rhapsody Tracks, Deezer Tracks, iHeartRadio Tracks, Napster, Tidal, SoundCloud, Amazon Music 4.4.12 Get HEOS Playlists Refer to Browse Sources and Browse Source
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 33
    given album id. This command facilitates controllers to retrieve and update their UI with cover art, if image_url in browse/search ' command Comment Currently supported media sources are Rhapsody/Napster Rhapsody/Napster album ids Note: Supported music service is Rhapsody and Napster
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 34
    sid Source id returned by 'get_music_sources' command id Options available on now playing screen (options) Enumeration N/A Following options are currently supported for 'Get Service options for now playing screen': 11 - Thumbs Up (Pandora) 12 - Thumbs Down (Pandora) Note: This command returns
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 35
    Options for now playing screen', 'Browse Sources' and 'Browse Source Containers' command response. Following service options are currently supported: Option id 1 - Add Track to Library (Rhapsody) Example Command heos://browse/set_service_option?sid=2&option=1&mid=Tra.174684187 2 - Add Album
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 36
    =13&name=Love&scid=1 heos://browse/set_service_option?sid=1&option=13&name=Love&range=0, 10 13 - Create New Station by Shows Supported Services: iHeartRadio heos://browse/set_service_option?sid=7&option=13&name=Love&scid=5 mid station id obtained through 'browse source containers' command cid
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 37
    13 - Create New Station by Tracks Supported Services: iHeartRadio heos://browse/set_service_option?sid=7&option=13& through 'browse source' command on Favorites Note: Option 13 (Create New Station) supports optional range queries. Response: { "heos": { "command": " browse/set_service_option",
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 38
    5.1 Sources Changed Response: { "heos": { "command": "event/sources_changed", } } 5.2 Players Changed Response: { "heos": { "command": "event/players_changed", } } 5.3 Group Changed Response: { "heos": { "command": "event/groups_changed", } } 5.4 Source Data Changed Response: { "heos": { "command":
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 39
    5.7 Player Now Playing Progress Response: { "heos": { "command": " event/player_now_playing_progress", "message": "pid=player_id&cur_pos=position_ms&duration=duration_ms" } } 5.8 Player Playback Error Response: { "heos": { "command": " event/player_playback_error", "message": "pid=player_id&error=
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 40
    "command": "event/repeat_mode_changed", "message": "pid='player_id'&repeat='on_all_or_on_one_or_off'" } } 5.13 Player Shuffle Mode Changed Response: { "heos": { "command": "event/shuffle_mode_changed", "message": "pid='player_id'&shuffle='on_or_off'" } } 5.14 Group Status Changed Response { "heos":
  • Marantz SR7011 | HEOS_CLI_PROTOCOL_Specification_290616 - Page 41
    Error 12 System error&syserrno=-2 Processing Previous Command 13 Processing previous command Media can't be played 14 cannot play Option no supported 15 Option not supported Too many commands in message queue to process 16 Too many commands in queue Reached skip limit 17 Reached skip limit
  • 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
HEOS CLI Protocol Specification
1. Overview
1.1 Supported music services
2. Connection
2.1 Controller Design Guidelines
2.1.1 Driver Initialization
2.1.2 Caveats
2.1.2.1 Compatibility
2.1.2.2 Issues & Solutions
2.1.3 Miscellaneous
3. Command and Response Overview
3.1 Commands
3.2 Responses
4. Command and Response Details
4.1 System Commands
4.1.1 Register for Change Events
4.1.2 HEOS Account Check
4.1.3 HEOS Account Sign In
4.1.4 HEOS Account Sign Out
4.1.5 HEOS System Heart Beat
4.1.6 HEOS Speaker Reboot
4.1.7 Prettify JSON response
4.2 Player Commands
4.2.1 Get Players
4.2.2 Get Player Info
4.2.3 Get Play State
4.2.4 Set Play State
4.2.5 Get Now Playing Media
4.2.6 Get Volume
4.2.7 Set Volume
4.2.8 Volume Up
4.2.9 Volume Down
4.2.10 Get Mute
4.2.11 Set Mute
4.2.12 Toggle Mute
4.2.13 Get Play Mode
4.2.14 Set Play Mode
4.2.15 Get Queue
4.2.16 Play Queue Item
4.2.17 Remove Item(s) from Queue
4.2.18 Save Queue as Playlist
4.2.19 Clear Queue
4.2.20 Play Next
4.2.21 Play Previous
4.3 Group Commands
4.3.1 Get Groups
4.3.2 Get Group Info
4.3.3 Set Group
4.3.4 Get Group Volume
4.3.5 Set Group Volume
4.2.6 Group Volume Up
4.2.7 Group Volume Down
4.3.8 Get Group Mute
4.3.9 Set Group Mute
4.3.10 Toggle Group Mute
4.4 Browse Commands
4.4.1 Get Music Sources
4.4.2 Get Source Info
4.4.3 Browse Source
4.4.4 Browse Source Containers
4.4.5 Get Source Search Criteria
4.4.6 Search
4.4.7 Play Station
4.4.8 Play Preset Station
4.4.9 Play Input source
Limitations for the system when used multi devices.
4.4.10 Add Container to Queue with Options
4.4.11 Add Track to Queue with Options
4.4.12 Get HEOS Playlists
4.4.13 Rename HEOS Playlist