]> code.delx.au - pulseaudio/commitdiff
client: documented that pa_stream_drain() may only have a single operation active...
authorLennart Poettering <lennart@poettering.net>
Fri, 31 Jul 2009 21:09:16 +0000 (23:09 +0200)
committerLennart Poettering <lennart@poettering.net>
Fri, 31 Jul 2009 21:09:16 +0000 (23:09 +0200)
Closes #552.

src/pulse/stream.h

index cb8b74dc1feb72774a13127bcf219eb9fe053522..8a08421fc8f3a232b8c9f026f700fbb3de55605d 100644 (file)
@@ -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