mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-12-16 08:56:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Document that pa_simple_get_latency() can be used on record streams as well

Browse source 
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
This commit is contained in:
Peter Meerwald 2013-12-16 14:18:15 +01:00 • committed by Tanu Kaskinen
parent acc5c29018
commit ca2ec3a8ef
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/pulse/simple.h
View file

@ -78,12 +78,13 @@
* *
* \section ctrl_sec Buffer control * \section ctrl_sec Buffer control
* *
* \li pa_simple_get_latency() - Will return the total latency of
* the playback or record pipeline, respectively.
*
* If a playback stream is used then a few other operations are available: * If a playback stream is used then a few other operations are available:
* *
* \li pa_simple_drain() - Will wait for all sent data to finish playing. * \li pa_simple_drain() - Will wait for all sent data to finish playing.
* \li pa_simple_flush() - Will throw away all data currently in buffers. * \li pa_simple_flush() - Will throw away all data currently in buffers.
* \li pa_simple_get_latency() - Will return the total latency of
* the playback pipeline.
* *
* \section cleanup_sec Cleanup * \section cleanup_sec Cleanup
* *
@ -149,7 +150,7 @@ int pa_simple_read(
* a negative value. It is OK to pass NULL here. */ * a negative value. It is OK to pass NULL here. */
); );
/** Return the playback latency. */ /** Return the playback or record latency. */
pa_usec_t pa_simple_get_latency(pa_simple *s, int *error); pa_usec_t pa_simple_get_latency(pa_simple *s, int *error);
/** Flush the playback buffer. This discards any audio in the buffer. */ /** Flush the playback buffer. This discards any audio in the buffer. */