Skip to main content

Module command

Module command 

Source
Expand description

Commands that can be sent to HEOS devices.

These are organized into several modules, broadly categorized by the command ‘group’ as specified by the HEOS CLI specification. These modules are as follows:

  • system: Commands related to managing the HEOS control system as a whole.
  • player: Commands related to managing individual player devices.
  • group: Commands related to managing groups of HEOS devices.
  • browse: Commands related to source-specific browse and search functionality.

In addition, there is a raw module that allows users to construct raw commands in the event that the provided typed commands are insufficient, although this should be unlikely.

Modules§

browse
Commands to query music sources and browse/search for music.
group
Commands to query/control groups of players.
player
Commands to query/control individual players.
raw
Raw untyped commands.
system
Commands that affect the HEOS system.

Enums§

CommandError
Errors that can occur when sending commands.
CommandErrorCode
Error codes for when a command fails.

Traits§

Command
Typed Command.