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.

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

merged 1 commit into from
Sep 20, 2023

Conversation

Jaskowicz1
Copy link
Contributor

@Jaskowicz1 Jaskowicz1 commented Sep 20, 2023

discordvoiceclient.h was not referencing dpp::cluster::on_voice_buffer_send correctly, this has been altered. I've also changed the notice of the audio data needs to be... to be a warning, to which it also states that the audio will be affected if it isn't at that hz (just to inform people what will happen otherwise).

Documentation change checklist

  • My documentation changes follow the same style as the rest of the documentation and any examples follow the coding style guide.
  • I tested that my change works before raising the PR (via running doxygen, and testing examples).
  • I have not moved any existing pages or changed any existing URLs without strong justification as to why.
  • I have not generated content using AI or a desktop utility such as grammarly.

@netlify
Copy link

netlify bot commented Sep 20, 2023

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 1b9fd64
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/650ad27fb565900008896ba6
😎 Deploy Preview https://deploy-preview-871--dpp-dev.netlify.app/classdpp_1_1discord__voice__client
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@braindigitalis braindigitalis merged commit 785f283 into brainboxdotcc:dev Sep 20, 2023
28 checks passed
Copy link
Member

@Neko-Life Neko-Life left a comment

Choose a reason for hiding this comment

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

oh well just noticed it's merged already

*
* @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

@Jaskowicz1 Jaskowicz1 deleted the voice-client-note-changes branch September 25, 2023 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants