Skip to content

Commit ad03eac

Browse files
authored
Social SDK: Add AEC dump documentation for audio debugging (#7746)
Replace placeholder info about missing audio logs with comprehensive documentation for acoustic echo cancellation (AEC) debugging using Client::SetAecDump. Includes usage examples, best practices, and warnings about file sizes.
1 parent 1692cb3 commit ad03eac

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

docs/discord-social-sdk/how-to/debug-log.mdx

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,34 @@ client->AddLogCallback([](auto message, auto severity) {
3030
}, discordpp::LoggingSeverity::Info);
3131
```
3232
33-
:::info
34-
Audio logs are not included in the logs by default. We will update this guide to include audio logs in the future.
33+
### Audio Logging
34+
35+
For diagnosing issues with acoustic echo cancellation (AEC), you can use the [`Client::SetAecDump`] function. This
36+
enables diagnostic recording of audio input and output waveform data, which can be invaluable when troubleshooting echo,
37+
feedback, or other audio processing problems.
38+
39+
[`Client::SetAecDump`] Enables or disables AEC diagnostic recording. When enabled, the input and output waveform data will be written to the
40+
log directory (the same directory specified by [`Client::SetLogDir`]).
41+
42+
```cpp
43+
// Enable AEC diagnostic recording
44+
client->SetAecDump(true);
45+
46+
// ... perform voice chat operations to reproduce the issue ...
47+
48+
// Disable AEC diagnostic recording when done
49+
client->SetAecDump(false);
50+
```
51+
52+
**When to use:**
53+
- Users report echo or feedback during voice chat
54+
- Audio quality issues that may be related to echo cancellation
55+
- Testing AEC performance in different environments
56+
- Debugging audio processing pipeline issues
57+
58+
:::warn
59+
AEC dump files can become large quickly as they contain raw waveform data. Remember to disable the diagnostic recording
60+
once you've captured the necessary data for analysis.
3561
:::
3662

3763
---
@@ -62,4 +88,5 @@ Audio logs are not included in the logs by default. We will update this guide to
6288

6389
{/* Autogenerated Reference Links */}
6490
[`Client::AddLogCallback`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#af78996cff24a40f5dc7066beed16692c
91+
[`Client::SetAecDump`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a3a05b2cafaa546d915a5249c63f4059f
6592
[`Client::SetLogDir`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a23bd5802dfa3072201ea864ee839c001

0 commit comments

Comments
 (0)