1.1.3.6.11 DRV_GENERICCODEC_VolumeGet Function

uint8_t DRV_GENERICCODEC_VolumeGet(DRV_HANDLE handle, DRV_GENERICCODEC_CHANNEL channel)

Summary

This function gets the volume for Generic Codec.

Description

This functions gets the current volume 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

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;

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

volume = DRV_GENERICCODEC_VolumeGet(myGENERICCODECHandle, DRV_GENERICCODEC_CHANNEL_LEFT);

C

uint8_t DRV_GENERICCODEC_VolumeGet(DRV_HANDLE handle, DRV_GENERICCODEC_CHANNEL channel);