Data Fields
PDMCC26XX_Object Struct Reference

PDMCC26XX Object. More...

#include <PDMCC26XX.h>

Data Fields

bool useDefaultFilter
 
bool streamStarted
 
bool micPowerActiveHigh
 
bool applyCompression
 
bool isOpen
 
uint16_t retBufSizeInBytes
 
uint16_t pcmBufferSizeInBytes
 
uint32_t startupDelayWithClockInSamples
 
int32_t * decimationFilter
 
PDMCC26XX_StreamNotificationstreamNotification
 
PDMCC26XX_Gain micGain
 
PDMCC26XX_CallbackFxn callbackFxn
 
PDMCC26XX_MallocFxn mallocFxn
 
PDMCC26XX_FreeFxn freeFxn
 
PIN_State pinState
 
PIN_Handle pinHandle
 
ti_sysbios_family_arm_m3_Hwi_Struct hwi
 

Detailed Description

PDMCC26XX Object.

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

Field Documentation

§ useDefaultFilter

bool PDMCC26XX_Object::useDefaultFilter

Set to TRUE to apply default filter. Set to FALSE to apply PDMCC26XX_Params::decimationFilter.

§ streamStarted

bool PDMCC26XX_Object::streamStarted

Stream started flag

§ micPowerActiveHigh

bool PDMCC26XX_Object::micPowerActiveHigh

Set to TRUE if setting the GPIO high powers the microphone

§ applyCompression

bool PDMCC26XX_Object::applyCompression

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

§ isOpen

bool PDMCC26XX_Object::isOpen

Has the object been opened

§ retBufSizeInBytes

uint16_t PDMCC26XX_Object::retBufSizeInBytes

Size of returned buffers

§ pcmBufferSizeInBytes

uint16_t PDMCC26XX_Object::pcmBufferSizeInBytes

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

§ 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.

§ decimationFilter

int32_t* PDMCC26XX_Object::decimationFilter

Filter that is applied if PDMCC26XX_Params::decimationFilter is set to FALSE

§ streamNotification

PDMCC26XX_StreamNotification* PDMCC26XX_Object::streamNotification

Stream state variable

§ micGain

PDMCC26XX_Gain PDMCC26XX_Object::micGain

Microphone gain

§ callbackFxn

PDMCC26XX_CallbackFxn PDMCC26XX_Object::callbackFxn

Callback function pointer

§ mallocFxn

PDMCC26XX_MallocFxn PDMCC26XX_Object::mallocFxn

Malloc function pointer

§ freeFxn

PDMCC26XX_FreeFxn PDMCC26XX_Object::freeFxn

Free function pointer

§ pinState

PIN_State PDMCC26XX_Object::pinState

Pin driver state object

§ pinHandle

PIN_Handle PDMCC26XX_Object::pinHandle

Pin driver handle

§ hwi

ti_sysbios_family_arm_m3_Hwi_Struct PDMCC26XX_Object::hwi

Hwi object handle


The documentation for this struct was generated from the following file:
Copyright 2017, Texas Instruments Incorporated