From c3c4937b4f3bd83a34864ec0a89b7b9113778da8 Mon Sep 17 00:00:00 2001 From: Arun Raghavan Date: Tue, 12 Jan 2016 15:31:06 +0530 Subject: [PATCH] stream: Clarify pa_stream_writable_size() documentation --- src/pulse/stream.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/pulse/stream.h b/src/pulse/stream.h index 70fa41598..ab233d570 100644 --- a/src/pulse/stream.h +++ b/src/pulse/stream.h @@ -588,7 +588,14 @@ int pa_stream_peek( * calling pa_stream_peek(). */ int pa_stream_drop(pa_stream *p); -/** Return the number of bytes that may be written using pa_stream_write(). */ +/** Return the number of bytes requested by the server that have not yet + * been written. + * + * It is possible to write more than this amount, up to the stream's + * buffer_attr.maxlength bytes. This is usually not desirable, though, as + * it would increase stream latency to be higher than requested + * (buffer_attr.tlength). + */ size_t pa_stream_writable_size(pa_stream *p); /** Return the number of bytes that may be read using pa_stream_peek(). */