mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-09 13:29:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

stream: Clarify pa_stream_writable_size() documentation

Browse source
This commit is contained in:
Arun Raghavan 2016-01-12 15:31:06 +05:30
parent 2ae2dab307
commit c3c4937b4f
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/pulse/stream.h
View file

@ -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(). */