diff options
| author | Peter Meerwald <p.meerwald@bct-electronic.com> | 2013-12-16 14:18:16 +0100 |
|---|---|---|
| committer | Tanu Kaskinen <tanu.kaskinen@linux.intel.com> | 2013-12-20 12:49:49 +0200 |
| commit | 586324f0fce0cd89e764147271f7f66a21a2ed38 (patch) | |
| tree | 4894199942cde84e20015f5bd75e7cd165e2c40e | |
| parent | ca2ec3a8ef97fedb622b81e45bf6fe1fcb51f216 (diff) | |
doc: Document that pa_stream_flush() is applicable to playback and record streams
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
| -rw-r--r-- | src/pulse/stream.h | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/src/pulse/stream.h b/src/pulse/stream.h index e3f2d96b..9fab629e 100644 --- a/src/pulse/stream.h +++ b/src/pulse/stream.h @@ -200,7 +200,7 @@ * \li pa_stream_drain() - Wait for the playback buffer to go empty. Will * return a pa_operation object that will indicate when * the buffer is completely drained. - * \li pa_stream_flush() - Drop all data from the playback buffer and do not + * \li pa_stream_flush() - Drop all data from the playback or record buffer. Do not * wait for it to finish playing. * * \section seek_modes Seeking in the Playback Buffer @@ -650,10 +650,9 @@ void pa_stream_set_buffer_attr_callback(pa_stream *p, pa_stream_notify_cb_t cb, * the stream, it will be created in corked state. */ pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata); -/** Flush the playback buffer of this stream. This discards any audio data +/** Flush the playback or record buffer of this stream. This discards any audio data * in the buffer. Most of the time you're better off using the parameter - * \a seek of pa_stream_write() instead of this function. Available on both - * playback and recording streams. */ + * \a seek of pa_stream_write() instead of this function. */ pa_operation* pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata); /** Reenable prebuffering if specified in the pa_buffer_attr |