]> code.delx.au - pulseaudio/commitdiff
doc: Document that pa_simple_get_latency() can be used on record streams as well
authorPeter Meerwald <p.meerwald@bct-electronic.com>
Mon, 16 Dec 2013 13:18:15 +0000 (14:18 +0100)
committerTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Fri, 20 Dec 2013 10:49:27 +0000 (12:49 +0200)
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
src/pulse/simple.h

index 222476609874630666242351f0de76fcb55cff79..ea2d0fb72a125ecc8388fbec2440e7ba65cc44d5 100644 (file)
  *
  * \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:
  *
  * \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_get_latency() - Will return the total latency of
- *                               the playback pipeline.
  *
  * \section cleanup_sec Cleanup
  *
@@ -149,7 +150,7 @@ int pa_simple_read(
      * 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);
 
 /** Flush the playback buffer. This discards any audio in the buffer. */