summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Sinclair <radarsat1@gmail.com>2019-04-17 13:51:14 +0200
committerStephen Sinclair <radarsat1@gmail.com>2019-04-17 14:05:55 +0200
commit4ea20ca26fae8f35401ee54cf526d892370aa1a0 (patch)
tree0295dcceb8e079bdc44a7248aa7e7d71086b160a
parent7da164bbb0ba05f471f7d2b11ec2f22c3e14be33 (diff)
[doc] callback return value in \return field
-rw-r--r--RtAudio.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/RtAudio.h b/RtAudio.h
index 4bb7554..8afc04d 100644
--- a/RtAudio.h
+++ b/RtAudio.h
@@ -193,6 +193,7 @@ static const RtAudioStreamStatus RTAUDIO_OUTPUT_UNDERFLOW = 0x2; // The output
\param userData A pointer to optional data provided by the client
when opening the stream (default = NULL).
+ \return
To continue normal stream operation, the RtAudioCallback function
should return a value of zero. To stop the stream and drain the
output buffer, the function should return a value of one. To abort