* playback or capture needs. It can only support a single stream per
* connection and has no handling of complex features like events, channel
* mappings and volume control. It is, however, very simple to use and
- * quite sufficent for many programs.
+ * quite sufficient for many programs.
*
* \section conn_sec Connecting
*
*
* \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_playback_latency() - Will return the total latency of
- * the playback pipeline.
+ * \li pa_simple_get_latency() - Will return the total latency of
+ * the playback pipeline.
*
* \section cleanup_sec Cleanup
*
/** \file
* A simple but limited synchronous playback and recording
* API. This is a synchronous, simplified wrapper around the standard
- * asynchronous API. */
+ * asynchronous API.
+ *
+ * See also \subpage simple
+ */
/** \example pacat-simple.c
* A simple playback tool using the simple API */
/** Return the playback latency. */
pa_usec_t pa_simple_get_latency(pa_simple *s, int *error);
-/** Flush the playback buffer. */
+/** Flush the playback buffer. This discards any audio in the buffer. */
int pa_simple_flush(pa_simple *s, int *error);
PA_C_DECL_END