1.1.2.6.1 DRV_AK4954_MicGainGet Function

uint8_t DRV_AK4954_MicGainGet(DRV_HANDLE handle)

Summary

This function gets the microphone gain for the AK4954 Codec.

Description

This functions gets the current microphone gain programmed to the Codec AK4954.

Preconditions

The DRV_AK4954_Initialize routine must have been called for the specified AK4954 driver instance.

DRV_AK4954_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

Returns

Microphone gain, in range 0-31.

Remarks

None.

Example

_\/\/ myAppObj is an application specific object._ MY_APP_OBJ myAppObj; uint8_t gain;

_\/\/ myAK4954Handle is the handle returned \/\/ by the DRV_AK4954_Open function._

gain = DRV_AK4954_MicGainGet(myAK4954Handle);

C

uint8_t DRV_AK4954_MicGainGet(DRV_HANDLE handle);