summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClemens Ladisch <clemens@ladisch.de>2009-02-11 09:53:29 +0100
committerClemens Ladisch <clemens@ladisch.de>2009-02-11 09:53:29 +0100
commit1009f9859c61b26e73b06e9bca7ea6ced9d95b0b (patch)
treeef2b1a732060d4b38b4bf58672799a330f5d7b3d
parent548dd9be908257a03e550c1bc7a8ddd582ff193f (diff)
downloadalsa-lib-1009f9859c61b26e73b06e9bca7ea6ced9d95b0b.tar.gz
fix pcm_set_params() documentation
The documentation for the latency parameter of pcm_set_params() says that the value 0 uses an optimal value. This is wrong, as there is no special handling for 0, and the result will be a buffer of minimal size. Therefore, remove that incorrect statement. Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
-rw-r--r--src/pcm/pcm.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index b44956fb..209c5bb0 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -7257,7 +7257,7 @@ int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent)
* \param channels required PCM channels
* \param rate required sample rate in Hz
* \param soft_resample 0 = disallow alsa-lib resample stream, 1 = allow resampling
- * \param latency required overall latency in us (0 = optimum latency for players)
+ * \param latency required overall latency in us
* \return 0 on success otherwise a negative error code
*/
int snd_pcm_set_params(snd_pcm_t *pcm,