mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-03 09:01:52 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

pcm: improve docs for snd_pcm_sw_params_get_avail_min() and snd_pcm_status_get_avail_max()

Browse source 
Fixes: https://github.com/alsa-project/alsa-lib/issues/44
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2021-06-18 11:35:30 +02:00
parent 119d9c1678
commit 3f737a2a2c
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/pcm/pcm.c
View file

@ -6500,6 +6500,9 @@ int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params,
* \param params Software configuration container * \param params Software configuration container
* \param val returned minimum available frames to consider PCM ready * \param val returned minimum available frames to consider PCM ready
* \return 0 otherwise a negative error code * \return 0 otherwise a negative error code
*
* This is a threshold value when the PCM stream is considered as ready for
* another read/write operation or poll event.
*/ */
#ifndef DOXYGEN #ifndef DOXYGEN
EXPORT_SYMBOL int INTERNAL(snd_pcm_sw_params_get_avail_min)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) EXPORT_SYMBOL int INTERNAL(snd_pcm_sw_params_get_avail_min)(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
@ -6960,6 +6963,8 @@ snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj)
/** /**
* \brief Get maximum number of frames available from a PCM status container after last #snd_pcm_status call * \brief Get maximum number of frames available from a PCM status container after last #snd_pcm_status call
* \return Maximum number of frames ready to be read/written * \return Maximum number of frames ready to be read/written
*
* This value returns the peak for the available frames between #snd_pcm_status calls.
*/ */
snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj) snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj)
{ {