[AudioManager] Improve documentation #6352
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SeungbaeShin
approved these changes
Sep 25, 2024
hsgwon
approved these changes
Sep 25, 2024
| /// Sets the sample format for the audio device. | ||
| /// This method allows developers to specify a desired <see cref="AudioSampleFormat"/> for | ||
| /// audio playback or recording. Setting an appropriate sample format is essential for | ||
| /// ensuring compatibility with the audio data being processed. |
There was a problem hiding this comment.
I think the last sentence is not that much helpful. could you remove that?
There was a problem hiding this comment.
sure "Setting an appropriate sample format is essential for ensuring compatibility with the audio data being processed." will be removed
| /// Sets the 'avoid resampling' property for the audio device. | ||
| /// This property controls whether the device should avoid resampling audio data during playback. | ||
| /// Enabling this feature can help preserve audio quality by preventing alterations to audio that | ||
| /// may happen during format conversions. |
There was a problem hiding this comment.
I guess "during playback" is more proper instead of "during format conversions".
Signed-off-by: Jaechul Lee <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
Improve documentation