summaryrefslogtreecommitdiff
path: root/src/pulse/simple.h
diff options
context:
space:
mode:
authorPeter Meerwald <p.meerwald@bct-electronic.com>2013-12-16 14:18:17 +0100
committerTanu Kaskinen <tanu.kaskinen@linux.intel.com>2013-12-20 12:50:23 +0200
commita247f7c58160bfd93039695cd7e60aa6108d53f4 (patch)
tree071e72d30bad70799139290dd6df831a623349ab /src/pulse/simple.h
parent586324f0fce0cd89e764147271f7f66a21a2ed38 (diff)
downloadpulseaudio-a247f7c58160bfd93039695cd7e60aa6108d53f4.tar.gz
simple: Enable pa_simple_flush() on record streams and amend documentation
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Diffstat (limited to 'src/pulse/simple.h')
-rw-r--r--src/pulse/simple.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/pulse/simple.h b/src/pulse/simple.h
index ea2d0fb72..54003ffbc 100644
--- a/src/pulse/simple.h
+++ b/src/pulse/simple.h
@@ -80,11 +80,11 @@
*
* \li pa_simple_get_latency() - Will return the total latency of
* the playback or record pipeline, respectively.
+ * \li pa_simple_flush() - Will throw away all data currently in buffers.
*
- * If a playback stream is used then a few other operations are available:
+ * If a playback stream is used then the following operation is 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.
*
* \section cleanup_sec Cleanup
*
@@ -153,7 +153,7 @@ int pa_simple_read(
/** 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. */
+/** Flush the playback or record buffer. This discards any audio in the buffer. */
int pa_simple_flush(pa_simple *s, int *error);
PA_C_DECL_END