PDMCC26XX_Object Struct Reference

PDMCC26XX Object. More...

Data Fields
bool	applyCompression
PDMCC26XX_CallbackFxn	callbackFxn
const int32_t *	decimationFilter
uint32_t *	decimationFilterState
size_t	decimationFilterStateSize
PDMCC26XX_FreeFxn	freeFxn
HwiP_Struct	hwi
bool	isOpen
PDMCC26XX_MallocFxn	mallocFxn
bool	micPowerActiveHigh
uint16_t	pcmBufferSizeInBytes
PDMCC26XX_Pdm2PcmFxn	pdm2pcmFxn
uint16_t	retBufSizeInBytes
uint32_t	startupDelayWithClockInSamples
PDMCC26XX_StreamNotification *	streamNotification
bool	streamStarted

Detailed Description

PDMCC26XX Object.

The application must not access any member variables of this structure!

Field Documentation

applyCompression

bool PDMCC26XX_Object::applyCompression

Set to TRUE to apply compression. Setting it to FALSE allows user to apply own compression scheme.

callbackFxn

PDMCC26XX_CallbackFxn PDMCC26XX_Object::callbackFxn

Callback function pointer

decimationFilter

const int32_t* PDMCC26XX_Object::decimationFilter

Filter applied during PDM to PCM conversion. Will use default filter if NULL.

decimationFilterState

uint32_t* PDMCC26XX_Object::decimationFilterState

Decimation filter state information.

decimationFilterStateSize

size_t PDMCC26XX_Object::decimationFilterStateSize

Size of the decimation filter state information in bytes. Should be 6 + 2 * N words long, where N is the number of filter stages in PDMCC26XX_Params.decimationFilter for the default filter.

freeFxn

PDMCC26XX_FreeFxn PDMCC26XX_Object::freeFxn

Free function pointer

hwi

HwiP_Struct PDMCC26XX_Object::hwi

Hwi object handle

isOpen

bool PDMCC26XX_Object::isOpen

Has the object been opened

mallocFxn

PDMCC26XX_MallocFxn PDMCC26XX_Object::mallocFxn

Malloc function pointer

micPowerActiveHigh

bool PDMCC26XX_Object::micPowerActiveHigh

Set to TRUE if setting the GPIO high powers the microphone

pcmBufferSizeInBytes

uint16_t PDMCC26XX_Object::pcmBufferSizeInBytes

Size of the pcm buffer inside the returnBuffer is equal to retBufSizeInBytes - PCM_METADATA_SIZE

pdm2pcmFxn

PDMCC26XX_Pdm2PcmFxn PDMCC26XX_Object::pdm2pcmFxn

Function that converts PDM input to PCM output

retBufSizeInBytes

uint16_t PDMCC26XX_Object::retBufSizeInBytes

Size of returned buffers

startupDelayWithClockInSamples

uint32_t PDMCC26XX_Object::startupDelayWithClockInSamples

Some digital microphones have a startup delay. Set the number of samples to discard after powering the microphone starting to clock in data.

streamNotification

PDMCC26XX_StreamNotification* PDMCC26XX_Object::streamNotification

Stream state variable

streamStarted

bool PDMCC26XX_Object::streamStarted

Stream started flag

---

The documentation for this struct was generated from the following file:

• PDMCC26XX.h