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: snd_pcm_(physical_)format_width() - change documentation

Browse source 
The word "nominal" is not so correct here. Use similar
wording as we use in the kernel space (the bit-width of the format).

Link: https://github.com/larsimmisch/pyalsaaudio/pull/146
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2024-02-22 18:57:33 +01:00
parent d8ce72f256
commit 19be3b23b3
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pcm/pcm_misc.c
View file

@ -203,9 +203,9 @@ int snd_pcm_format_cpu_endian(snd_pcm_format_t format)
}
/**
* \brief Return nominal bits per a PCM sample
* \brief Return the bit-width of the format
* \param format Sample format
* \return bits per sample, a negative error code if not applicable
* \return the bit-width of the format, or a negative error code if not applicable
*/
int snd_pcm_format_width(snd_pcm_format_t format)
{
@ -270,9 +270,9 @@ int snd_pcm_format_width(snd_pcm_format_t format)
}
/**
* \brief Return bits needed to store a PCM sample
* \brief Return the physical bit-width of the format (bits needed to store a PCM sample)
* \param format Sample format
* \return bits per sample, a negative error code if not applicable
* \return the physical bit-width of the format, or a negative error code if not applicable
*/
int snd_pcm_format_physical_width(snd_pcm_format_t format)
{