Skip to content

Commit 271ba12

Browse files
authored
Document multi-level DialogLevel and SpeechEnhanceEnabled behavior for GetEQ / SetEQ (#50)
* Updated Documentation to support dynamic levels for dialog. Updated GetEQ and SetEQ
1 parent e89616e commit 271ba12

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/documentation.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@
396396
"GetEQ": {
397397
"description": "Get equalizer value",
398398
"params": {
399-
"EQType": "Allowed values `DialogLevel` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10)",
400-
"CurrentValue": "Booleans return `1` / `0`, rest number as specified"
399+
"EQType": "Allowed values `DialogLevel` (string, 1–4 on supported devices: 1 = low, 2 = medium, 3 = high, 4 = max) / `SpeechEnhanceEnabled` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10)",
400+
"CurrentValue": "Booleans return `1` / `0`; `DialogLevel` returns a string value representing the dialog intensity level, rest return number as specified"
401401
},
402402
"remarks": "Not all EQ types are available on every speaker"
403403
},
@@ -422,10 +422,10 @@
422422
"SetEQ": {
423423
"description": "Set equalizer value for different types",
424424
"params": {
425-
"EQType": "Allowed values `DialogLevel` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10)",
426-
"DesiredValue": "Booleans required `1` for true or `0` for false, rest number as specified"
425+
"EQType": "Allowed values `DialogLevel` (string, 1–4 on supported devices: 1 = low, 2 = medium, 3 = high, 4 = max) / `SpeechEnhanceEnabled` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10)",
426+
"DesiredValue": "Booleans return `1` / `0`; `DialogLevel` returns a string value representing the dialog intensity levels, rest number as specified"
427427
},
428-
"remarks": "Not supported by all speakers, TV related"
428+
"remarks": "On newer devices (e.g. Arc Ultra), dialog enhancement on/off is controlled via `SpeechEnhanceEnabled`, while `DialogLevel` represents the intensity level (1 = low, 2 = medium, 3 = high, 4 = max) and does not return 0 when disabled. Not all EQ types are available on every speaker. Not supported by all speakers, TV related"
429429
},
430430
"SetLoudness": {
431431
"description": "Set loudness on / off"

docs/services/rendering-control.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,13 @@ Inputs:
8989
| parameter | type | description |
9090
|:----------|:-----|:------------|
9191
| **InstanceID** | `ui4` | InstanceID should always be `0` |
92-
| **EQType** | `string` | Allowed values `DialogLevel` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10) |
92+
| **EQType** | `string` | Allowed values `DialogLevel` (string, 1–4 on supported devices: 1 = low, 2 = medium, 3 = high, 4 = max) / `SpeechEnhanceEnabled` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10) |
9393

9494
Outputs:
9595

9696
| parameter | type | description |
9797
|:----------|:-----|:------------|
98-
| **CurrentValue** | `i2` | Booleans return `1` / `0`, rest number as specified |
98+
| **CurrentValue** | `i2` | Booleans return `1` / `0`; `DialogLevel` returns a string value representing the dialog intensity level, rest return number as specified |
9999

100100
**Remarks** Not all EQ types are available on every speaker
101101

@@ -488,10 +488,10 @@ Inputs:
488488
| parameter | type | description |
489489
|:----------|:-----|:------------|
490490
| **InstanceID** | `ui4` | InstanceID should always be `0` |
491-
| **EQType** | `string` | Allowed values `DialogLevel` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10) |
492-
| **DesiredValue** | `i2` | Booleans required `1` for true or `0` for false, rest number as specified |
491+
| **EQType** | `string` | Allowed values `DialogLevel` (string, 1–4 on supported devices: 1 = low, 2 = medium, 3 = high, 4 = max) / `SpeechEnhanceEnabled` (bool) / `MusicSurroundLevel` (-15/+15) / `NightMode` (bool) / `SubGain` (-10/+10) / `SurroundEnable` (bool) / `SurroundLevel` (-15/+15) / `SurroundMode` (0 = ambient, 1 = full) / `HeightChannelLevel` (-10/+10) |
492+
| **DesiredValue** | `i2` | Booleans return `1` / `0`; `DialogLevel` returns a string value representing the dialog intensity levels, rest number as specified |
493493

494-
**Remarks** Not supported by all speakers, TV related
494+
**Remarks** On newer devices (e.g. Arc Ultra), dialog enhancement on/off is controlled via `SpeechEnhanceEnabled`, while `DialogLevel` represents the intensity level (1 = low, 2 = medium, 3 = high, 4 = max) and does not return 0 when disabled. Not all EQ types are available on every speaker. Not supported by all speakers, TV related
495495

496496
### SetLoudness
497497

0 commit comments

Comments
 (0)