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: clarify documentation on some hw params related functions

Browse source 
Closes: https://github.com/alsa-project/alsa-lib/pull/369
Signed-off-by: Zeno Endemann <zeno.endemann@mailbox.org>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Zeno Endemann 2023-11-24 13:49:49 +01:00 • committed by Jaroslav Kysela
parent caab680d7e
commit 454638ef30
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pcm/pcm.c
View file

@ -894,6 +894,7 @@ int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info)
* \param pcm PCM handle * \param pcm PCM handle
* \param params Configuration space definition container * \param params Configuration space definition container
* \return 0 on success otherwise a negative error code * \return 0 on success otherwise a negative error code
* \retval -EBADFD no hardware configuration is set
*/ */
int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params) int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
{ {
@ -960,6 +961,8 @@ int snd_pcm_hw_params(snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
/** \brief Remove PCM hardware configuration and free associated resources /** \brief Remove PCM hardware configuration and free associated resources
* \param pcm PCM handle * \param pcm PCM handle
* \return 0 on success otherwise a negative error code * \return 0 on success otherwise a negative error code
*
* The function will also report success if no configuration is set.
*/ */
int snd_pcm_hw_free(snd_pcm_t *pcm) int snd_pcm_hw_free(snd_pcm_t *pcm)
{ {
@ -3929,6 +3932,11 @@ int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params)
* *
* The configuration space will be filled with all possible ranges * The configuration space will be filled with all possible ranges
* for the PCM device. * for the PCM device.
*
* Note that the configuration space may be constrained by the
* currently installed configuration on the PCM device. To remove
* any constrains, free the configuration with #snd_pcm_hw_free
* first.
*/ */
int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params) int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
{ {