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

ctl: improve documentation about TLV-related APIs

Browse source 
The documentation gives no hints to users about format of TLV data.

This commit add hints to construct/parse the information.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Takashi Sakamoto 2016-09-29 08:57:23 +09:00 • committed by Takashi Iwai
parent d31e37d12c
commit e55d735f84
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/control/control.c
View file

@ -918,6 +918,13 @@ static int snd_ctl_tlv_do(snd_ctl_t *ctl, int op_flag,
* \param tlv An array with members of unsigned int type. * \param tlv An array with members of unsigned int type.
* \param tlv_size The length of the array. * \param tlv_size The length of the array.
* \return 0 on success otherwise a negative error code * \return 0 on success otherwise a negative error code
*
* The format of an array of \a tlv argument is:
* tlv[0]: Type. One of SND_CTL_TLVT_XXX.
* tlv[1]: Length. The length of value in units of byte.
* tlv[2..]: Value. Depending on the type.
*
* Details are described in <sound/tlv.h>.
*/ */
int snd_ctl_elem_tlv_read(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, int snd_ctl_elem_tlv_read(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
unsigned int *tlv, unsigned int tlv_size) unsigned int *tlv, unsigned int tlv_size)
@ -948,6 +955,13 @@ int snd_ctl_elem_tlv_read(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
* \retval 0 on success * \retval 0 on success
* \retval >0 on success when value was changed * \retval >0 on success when value was changed
* \retval <0 a negative error code * \retval <0 a negative error code
*
* The format of an array of \a tlv argument is:
* tlv[0]: Type. One of SND_CTL_TLVT_XXX.
* tlv[1]: Length. The length of value in units of byte.
* tlv[2..]: Value. Depending on the type.
*
* Details are described in <sound/tlv.h>.
*/ */
int snd_ctl_elem_tlv_write(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, int snd_ctl_elem_tlv_write(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
const unsigned int *tlv) const unsigned int *tlv)
@ -965,6 +979,13 @@ int snd_ctl_elem_tlv_write(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
* \retval 0 on success * \retval 0 on success
* \retval >0 on success when value was changed * \retval >0 on success when value was changed
* \retval <0 a negative error code * \retval <0 a negative error code
*
* The format of an array of \a tlv argument is:
* tlv[0]: Type. One of SND_CTL_TLVT_XXX.
* tlv[1]: Length. The length of value in units of byte.
* tlv[2..]: Value. Depending on the type.
*
* Details are described in <sound/tlv.h>.
*/ */
int snd_ctl_elem_tlv_command(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, int snd_ctl_elem_tlv_command(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
const unsigned int *tlv) const unsigned int *tlv)