USBD_Audio_DrvCtrlFU_AutoGainManage

Description

Get the auto gain state for one or all logical channels inside a cluster.

Files

usbd_audio_drv_<codec-name>.h / usbd_audio_drv_<codec-name>.c

Prototype

static  CPU_BOOLEAN  USBD_Audio_DrvCtrlFU_AutoGainManage (USBD_AUDIO_DRV  *p_audio_drv,
                                                          CPU_INT08U       unit_id,
                                                          CPU_INT08U       log_ch_nbr,
                                                          CPU_BOOLEAN      set_en,
                                                          CPU_BOOLEAN     *p_auto_gain);

Arguments

p_audio_drv

Pointer to audio driver structure.

unit_id

Feature Unit ID.

log_ch_nbr

Logical channel number.

set_en

Flag indicating to get or set the gain.

p_auto_gain

Pointer to the auto gain value to get or set.

Returned Value

DEF_OK, if NO error(s) occurred and request is supported.

DEF_FAIL, otherwise.

Callers

Audio Class.

Implementation guidelines

log_ch_nbr allows you to get the auto gain state for a specific channel. When log_ch_nbr is 0, you get the auto gain state for all channels. Indeed, the logical channel #0 represents the master channel and encompasses all channels.