pcm: fix comment for snd_pcm_avail_update()

In some cases, value might be used for r/w ops, too.

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2008-06-16 13:23:22 +02:00
parent 68641714a8
commit 5e91207586

View file

@ -2385,16 +2385,13 @@ int snd_pcm_wait_nocheck(snd_pcm_t *pcm, int timeout)
#endif
/**
* \brief Return number of frames ready to be read/written
* \brief Return number of frames ready to be read (capture) / written (playback)
* \param pcm PCM handle
* \return a positive number of frames ready otherwise a negative
* error code
*
* On capture does all the actions needed to transport to application
* level all the ready frames across underlying layers.
*
* Using of this function is useless for the standard read/write
* operations. Use it only for mmap access. See to #snd_pcm_delay.
*/
snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm)
{