Speaker Channel
Channel Category: speaker
Controls speaker devices, including volume, mute state, balance, and audio equalization.
Required Properties
| Property | Data Type | Range/Values | Unit | Permissions |
|---|---|---|---|---|
active | Bool | - | - | RW (Read-Write) |
Property Details
active
Indicates if the channel/sensor is currently active and functioning
Optional Properties
| Property | Data Type | Range/Values | Unit | Permissions |
|---|---|---|---|---|
volume | Uchar | 0–100 | % | RW (Read-Write) |
mode | Enum | stereo, mono, surround | - | RW (Read-Write) |
mute | Bool | - | - | RW (Read-Write) |
balance | Float | -1–1 | - | RW (Read-Write) |
bass | Float | -10–10 | - | RW (Read-Write) |
treble | Float | -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