From: Peter Meerwald
Date: Mon, 16 Dec 2013 13:18:17 +0000 (+0100)
Subject: simple: Enable pa_simple_flush() on record streams and amend documentation
X-Git-Url: https://code.delx.au/pulseaudio/commitdiff_plain/a247f7c58160bfd93039695cd7e60aa6108d53f4
simple: Enable pa_simple_flush() on record streams and amend documentation
Signed-off-by: Peter Meerwald
---
diff --git a/src/pulse/simple.c b/src/pulse/simple.c
index 9b8d14bf..18911316 100644
--- a/src/pulse/simple.c
+++ b/src/pulse/simple.c
@@ -423,8 +423,6 @@ int pa_simple_flush(pa_simple *p, int *rerror) {
pa_assert(p);
- CHECK_VALIDITY_RETURN_ANY(rerror, p->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE, -1);
-
pa_threaded_mainloop_lock(p->mainloop);
CHECK_DEAD_GOTO(p, rerror, unlock_and_fail);
diff --git a/src/pulse/simple.h b/src/pulse/simple.h
index ea2d0fb7..54003ffb 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