Skip to Content
🚀 We just launched! Please star us on Github!

Speaker Channel

Channel Category: speaker

Controls speaker devices, including volume, mute state, balance, and audio equalization.


Required Properties

PropertyData TypeRange/ValuesUnitPermissions
activeBool--RW (Read-Write)

Property Details

active

Indicates if the channel/sensor is currently active and functioning

Optional Properties

PropertyData TypeRange/ValuesUnitPermissions
volumeUchar0–100%RW (Read-Write)
modeEnumstereo, mono, surround-RW (Read-Write)
muteBool--RW (Read-Write)
balanceFloat-1–1-RW (Read-Write)
bassFloat-10–10-RW (Read-Write)
trebleFloat-10–10-RW (Read-Write)

Property Details

volume

Volume control - integrator can choose between percentage or discrete levels

This property supports multiple data type variants:

  • percentage: Uchar (0–100) in % - Volume as percentage (0-100%)
  • level: Enum (mute, low, medium, high, max) - Volume as discrete levels

mode

Operating mode selection

mute

Mute audio output.

balance

Left/right balance (-1.0..1.0).

bass

Bass adjustment.

treble

Treble adjustment.

Last updated on