mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

pcm: fix the documentation for snd_pcm_poll_descriptors again

Browse source 
As noted in the github issue, the poll descriptors may change depending
on the stream parameters.

Fixes: cd04da2b ("pcm: clarify documentation of poll descriptor usage")
Fixes: https://github.com/alsa-project/alsa-lib/issues/372
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2024-01-02 10:52:33 +01:00
parent 60d6fad711
commit d4992c36cc
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/pcm/pcm.c
View file

@ -1812,9 +1812,10 @@ static int __snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds,
* \link ::snd_pcm_poll_descriptors_revents() \endlink .
*
* It is guaranteed that for the given PCM handle, the output poll
* descriptor structs (and their count) will never change, thus it is
* valid to call the function once and reuse its output for the
* lifetime of the PCM device.
* descriptor structs (and their count) will not change after
* hardware and software parameters setup. Thus it is valid to call
* the function once when all parameters are set and reuse its output
* for the lifetime of the stream parameters.
*
* The function is thread-safe when built with the proper option.
*/