Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fixed a ref issue and added more info in discordvoiceclient.h #871

Merged
merged 1 commit into from
Sep 20, 2023
Merged

docs: fixed a ref issue and added more info in discordvoiceclient.h #871

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions include/dpp/discordvoiceclient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,13 +685,13 @@ class DPP_EXPORT discord_voice_client : public websocket_client
* ready to send and know its length it is advisable to call this
* method multiple times to enqueue the entire stream audio so that
* it is all encoded at once (unless you have set use_opus to false).
* Constantly calling this from the dpp::on_voice_buffer_send callback
* can and will eat a TON of cpu!
* **Constantly calling this from dpp::cluster::on_voice_buffer_send
* can, and will, eat a TON of cpu!**
*
* @param audio_data Raw PCM audio data. Channels are interleaved,
* with each channel's amplitude being a 16 bit value.
*
* The audio data should be 48000Hz signed 16 bit audio.
* @warning **The audio data needs to be 48000Hz signed 16 bit audio, otherwise, the audio will come through incorrectly!**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to replace "incorrectly" with a more explanatory term. Having a mismatched sample rate can alter the pitch and tempo of the audio playback. Specifically, a lower sample rate can result in a higher pitch and faster tempo, while a higher sample rate can produce the opposite effect

*
* @param length The length of the audio data. The length should
* be a multiple of 4 (2x 16 bit stereo channels) with a maximum
Expand Down
Loading