1.1.3.6.1 DRV_GENERICCODEC_MicGainGet Function
uint8_t DRV_GENERICCODEC_MicGainGet(DRV_HANDLE handle)
Summary
This function gets the microphone gain for the Generic Codec.
Description
This functions gets the current microphone gain programmed to the Generic Codec.
Preconditions
The DRV_GENERICCODEC_Initialize routine must have been called for the specified Generic Codec driver instance.
DRV_GENERICCODEC_Open must have been called to obtain a valid opened device handle.
Parameters
Parameters | Description |
---|---|
handle | A valid open-instance handle, returned from the driver's open routine |
Returns
Microphone gain, in range 0-31.
Remarks
None.
Example
_// myAppObj is an application specific object._ MY_APP_OBJ myAppObj; uint8_t gain; _// myGENERICCODECHandle is the handle returned // by the DRV_GENERICCODEC_Open function._ gain = DRV_GENERICCODEC_MicGainGet(myGENERICCODECHandle);
C
uint8_t DRV_GENERICCODEC_MicGainGet(DRV_HANDLE handle);