[pulseaudio-discuss] [PATCH 3/5] doc: Document that pa_simple_get_latency() can be used on record streams as well

[Peter Meerwald]

From: Peter Meerwald <p.meerwald at bct-electronic.com>

Signed-off-by: Peter Meerwald <pmeerw at pmeerw.net>
---
 src/pulse/simple.h |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/pulse/simple.h b/src/pulse/simple.h
index 2224766..ea2d0fb 100644
--- a/src/pulse/simple.h
+++ b/src/pulse/simple.h
@@ -78,12 +78,13 @@
  *
  * \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. */
-- 
1.7.9.5