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

simple: Improve pa_simple_read() documentation

Browse source 
There was a question in IRC about whether pa_simple_read() blocks or
not. It's already documented on the simple API overview page, but it's
good to say it also in the function reference. As a bonus, I added
some additional details to the documentation too.
This commit is contained in:
Tanu Kaskinen 2013-10-04 13:39:40 +03:00 • committed by Tanu Kaskinen
parent 38b8c42b35
commit 073051f983
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/pulse/simple.h
View file

@ -137,8 +137,17 @@ int pa_simple_write(pa_simple *s, const void *data, size_t bytes, int *error);
/** Wait until all data already written is played by the daemon. */
int pa_simple_drain(pa_simple *s, int *error);
/** Read some data from the server. */
int pa_simple_read(pa_simple *s, void *data, size_t bytes, int *error);
/** Read some data from the server. This function blocks until \a bytes amount
* of data has been received from the server, or until an error occurs.
* Returns a negative value on failure. */
int pa_simple_read(
pa_simple *s, /**< The connection object. */
void *data, /**< A pointer to a buffer. */
size_t bytes, /**< The number of bytes to read. */
int *error
/**< A pointer where the error code is stored when the function returns
* a negative value. It is OK to pass NULL here. */
);
/** Return the playback latency. */
pa_usec_t pa_simple_get_latency(pa_simple *s, int *error);