summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2009-07-31 23:09:16 +0200
committerLennart Poettering <lennart@poettering.net>2009-07-31 23:09:16 +0200
commit478f3254b36f9f4281d58bb048a002096b8d0bb9 (patch)
treed4ee4b844c687d4c33d5777e70c6a9c3b21337b9
parent2952f28c06b254f358ec9b3354dfc05c17a7b871 (diff)
client: documented that pa_stream_drain() may only have a single operation active at a time
Closes #552.
-rw-r--r--src/pulse/stream.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/pulse/stream.h b/src/pulse/stream.h
index cb8b74dc..8a08421f 100644
--- a/src/pulse/stream.h
+++ b/src/pulse/stream.h
@@ -512,7 +512,9 @@ size_t pa_stream_writable_size(pa_stream *p);
/** Return the number of bytes that may be read using pa_stream_peek()*/
size_t pa_stream_readable_size(pa_stream *p);
-/** Drain a playback stream. Use this for notification when the buffer is empty */
+/** Drain a playback stream. Use this for notification when the buffer
+ * is empty. Please note that only one drain operation per stream may
+ * be issued at a time. */
pa_operation* pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata);
/** Request a timing info structure update for a stream. Use