1.1.3.6.2 DRV_GENERICCODEC_MicGainSet Function

void DRV_GENERICCODEC_MicGainSet(DRV_HANDLE handle, uint8_t gain)

Summary

This function sets the microphone gain for the Generic Codec CODEC.

Description

This functions sets the microphone gain value from 0-31

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

ParametersDescription
handleA valid open-instance handle, returned from the driver's open routine
gainGain value, in range 0-31

Returns

None.

Remarks

None.

Example

_// myAppObj is an application specific object._

MY_APP_OBJ myAppObj;

_// myGENERICCODECHandle is the handle returned // by the DRV_GENERICCODEC_Open function._

DRV_GENERICCODEC_MicGainSet(myGENERICCODECHandle, 15); _//GENERICCODEC mic gain set to 15_

C

void DRV_GENERICCODEC_MicGainSet(DRV_HANDLE handle, uint8_t gain);