aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhil Burk <philburk@mobileer.com>2023-11-20 11:44:50 -0800
committerGitHub <noreply@github.com>2023-11-20 11:44:50 -0800
commit791e54d35269a46ea33651857dee8286c4226d80 (patch)
tree88cf1016f92ba1a6207cd85a75d00f1764aaf4e6
parentcd0f776bc473929c4bd9c94dd991ecd186fd8a64 (diff)
downloadoboe-791e54d35269a46ea33651857dee8286c4226d80.tar.gz
Update AudioStreamCallback.h, numFrames <= framesPerBurst
Fixes #1053
-rw-r--r--include/oboe/AudioStreamCallback.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/oboe/AudioStreamCallback.h b/include/oboe/AudioStreamCallback.h
index 17d28ba7..8d8e2feb 100644
--- a/include/oboe/AudioStreamCallback.h
+++ b/include/oboe/AudioStreamCallback.h
@@ -48,7 +48,8 @@ public:
* write() on the stream that is making the callback.
*
* Note that numFrames can vary unless AudioStreamBuilder::setFramesPerCallback()
- * is called.
+ * is called. If AudioStreamBuilder::setFramesPerCallback() is NOT called then
+ * numFrames should always be <= AudioStream::getFramesPerBurst().
*
* Also note that this callback function should be considered a "real-time" function.
* It must not do anything that could cause an unbounded delay because that can cause the