docs: Pa_OpenStream() fails if sampleRate unavailable (#446)

It was not clear in the previous docs.
Fixes #443
This commit is contained in:
Phil Burk 2021-01-21 08:17:27 -08:00 committed by GitHub
commit f7efb6b53c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -849,7 +849,10 @@ typedef int PaStreamCallback(
outputParameters must be NULL for input-only streams.
@param sampleRate The desired sampleRate. For full-duplex streams it is the
sample rate for both input and output
sample rate for both input and output. Note that the actual sampleRate
may differ very slightly from the desired rate because of hardware limitations.
The exact rate can be queried using Pa_GetStreamInfo(). If nothing close
to the desired sampleRate is available then the open will fail and return an error.
@param framesPerBuffer The number of frames passed to the stream callback
function, or the preferred block granularity for a blocking read/write stream.