Repository navigation
docs: clarify recording and playback parameters in playrec - #647
Open
kushaldave002 wants to merge 1 commit into
Open
kushaldave002 wants to merge 1 commit into
kushaldave002 wants to merge 1 commit into
Conversation
Problem Hardware input/output terminology can make channels, dtype, and out seem to refer to the opposite side of simultaneous playback and recording. Solution Describe channels, dtype, and mappings in terms of recording and playback. Explain that out holds recorded data from the device's input channels. Result The playrec reference makes each parameter's direction explicit without changing function names, arguments, or runtime behavior.
This branch has not been deployed
This file contains hidden or 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
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.
Fixes #388
playrec()describeschannelsanddtypeas input parameters, which can be mistaken for the playback array rather than the audio device's recording inputs.Describe the channels, data types, and mappings in terms of recording and playback. Clarify that
outis the function's output array containing recorded audio from the device's input channels. Function and parameter names stay unchanged.Validation:
playrec()reference and itsrec()/play()links.External linkcheck was stopped after GitHub rate-limited unchanged example-source URLs; it is not claimed to pass.