mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2026-02-26 01:40:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

pcm: add a note about return values of snd_pcm_state()

Browse source 
Fixes: https://github.com/alsa-project/alsa-lib/pull/162
Signed-off-by: Henrik Enquist <henrik.enquist@gmail.com>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Henrik Enquist 2021-07-07 21:10:16 +02:00 • committed by Jaroslav Kysela
parent aa04023565
commit c4972cb154
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/pcm/pcm.c
View file

@ -1059,6 +1059,10 @@ int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status)
* This is a faster way to obtain only the PCM state without calling * This is a faster way to obtain only the PCM state without calling
* \link ::snd_pcm_status() \endlink. * \link ::snd_pcm_status() \endlink.
* *
* Note that this function always returns one of the
* #snd_pcm_state_t enum variants.
* It will never return a negative error code.
*
* The function is thread-safe when built with the proper option. * The function is thread-safe when built with the proper option.
*/ */
snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm) snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm)