[alsa-devel] [PATCH 2/2] Improve hw_params documentation

[Clemens Ladisch]

Andrew Eikum wrote:
> +++ b/include/pcm.h
> @@ -44,8 +44,20 @@ extern "C" {
>
>  /** PCM generic info container */
>  typedef struct _snd_pcm_info snd_pcm_info_t;
> -/** PCM hardware configuration space container */
> +
> +/** PCM hardware configuration space container
> + *
> + *  snd_pcm_hw_params_t is an opaque structure which contains a set of possible
> + *  PCM hardware configurations. For example, a given instance might include a
> + *  range of buffer sizes, a range of period sizes, and a set of several sample
> + *  formats. Some subset of all possible combinations these sets may be valid,
> + *  but not necessarily any combination will be valid.
> + *
> + *  No validation is done by the various snd_pcm_hw_params_set* functions.

These functions do validate the value that the application is trying to set
and adjust all other dependent limits.


Regards,
Clemens