diff options
| author | Phil Burk <philburk@mobileer.com> | 2023-11-20 11:27:42 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-20 11:27:42 -0800 |
| commit | cd0f776bc473929c4bd9c94dd991ecd186fd8a64 (patch) | |
| tree | 706576ee74033f79f799c4d2b2c241be0858e4b0 | |
| parent | fc926d6b85fbf9a2ecb98520b84e9beb30ea7c5c (diff) | |
| download | oboe-cd0f776bc473929c4bd9c94dd991ecd186fd8a64.tar.gz | |
Improve docs for setBufferSizeInFrames
Fixes #403
| -rw-r--r-- | include/oboe/AudioStream.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/include/oboe/AudioStream.h b/include/oboe/AudioStream.h index 261772a1..01b8c976 100644 --- a/include/oboe/AudioStream.h +++ b/include/oboe/AudioStream.h @@ -194,6 +194,13 @@ public: * * This cannot be set higher than getBufferCapacity(). * + * This should only be used with Output streams. It will + * be ignored for Input streams because they are generally kept as empty as possible. + * + * For OpenSL ES, this method only has an effect on output stream that do NOT + * use a callback. The blocking writes goes into a buffer in Oboe and the size of that + * buffer is controlled by this method. + * * @param requestedFrames requested number of frames that can be filled without blocking * @return the resulting buffer size in frames (obtained using value()) or an error (obtained * using error()) |