1.1.4.6.5 DRV_WM8904_VolumeGet Function

uint8_t DRV_WM8904_VolumeGet(DRV_HANDLE handle, DRV_WM8904_CHANNEL channel)

Summary

This function gets the volume for WM8904 Codec.

Description

This functions gets the current volume programmed to the Codec WM8904.

Preconditions

The DRV_WM8904_Initialize routine must have been called for the specified WM8904 driver instance.

DRV_WM8904_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
channelargument indicating Left or Right or Both channel volume to be modified

Returns

None.

Remarks

None.

Example

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

_// myWM8904Handle is the handle returned // by the DRV_WM8904_Open function._

volume = DRV_WM8904_VolumeGet(myWM8904Handle, DRV_WM8904_CHANNEL_LEFT);

C

uint8_t DRV_WM8904_VolumeGet(DRV_HANDLE handle, DRV_WM8904_CHANNEL channel);