Microphone

Data Structures
struct	MICWorkMemory
struct	MICStatus

Typedefs
typedef int	MICHandle
typedef struct MICWorkMemory	MICWorkMemory
typedef struct MICStatus	MICStatus
typedef enum MICError	MICError
typedef enum MICInstance	MICInstance

Enumerations
enum	MICError {   MIC_ERROR_OK = 0 ,   MIC_ERROR_NOT_OPENED = -1 ,   MIC_ERROR_INVALID_HANDLE = -2 ,   MIC_ERROR_INIT = -5 ,   MIC_ERROR_ALREADY_CLOSED = -7 ,   MIC_ERROR_INVALID_INSTANCE = -8 }
enum	MICInstance {   MIC_INSTANCE_0 = 0 ,   MIC_INSTANCE_1 = 1 }

Functions
MICHandle	MICInit (MICInstance instance, int unused, MICWorkMemory *workMemory, MICError *outError)
	The second parameter to MICInit is unused, any value is valid. More...
MICError	MICOpen (MICHandle handle)
MICError	MICGetState (MICHandle handle, int state, uint32_t *outStateVal)
MICError	MICSetState (MICHandle handle, int state, uint32_t stateVal)
MICError	MICGetStatus (MICHandle handle, MICStatus *outStatus)
MICError	MICSetDataConsumed (MICHandle handle, int dataAmountConsumed)
MICError	MICClose (MICHandle handle)
MICError	MICUninit (MICHandle handle)

Detailed Description

---

Data Structure Documentation

MICWorkMemory

struct MICWorkMemory

Definition at line 35 of file mic.h.

Data Fields
size_t	sampleMaxCount	Maximum amount of samples at a time must be at least 0x2800.
void *	sampleBuffer	A 0x40 aligned buffer of size sampleMaxCount * 2.

MICStatus

struct MICStatus

Definition at line 47 of file mic.h.

Data Fields
int	state
int	availableData
int	bufferPos

Typedef Documentation

MICHandle

typedef int MICHandle

Definition at line 14 of file mic.h.

MICWorkMemory

typedef struct MICWorkMemory MICWorkMemory

Definition at line 14 of file mic.h.

MICStatus

typedef struct MICStatus MICStatus

Definition at line 14 of file mic.h.

MICError

typedef enum MICError MICError

MICInstance

typedef enum MICInstance MICInstance

Enumeration Type Documentation

MICError

enum MICError

Enumerator
MIC_ERROR_OK
MIC_ERROR_NOT_OPENED
MIC_ERROR_INVALID_HANDLE
MIC_ERROR_INIT
MIC_ERROR_ALREADY_CLOSED
MIC_ERROR_INVALID_INSTANCE

Definition at line 19 of file mic.h.

MICInstance

enum MICInstance

Enumerator
MIC_INSTANCE_0
MIC_INSTANCE_1

Definition at line 29 of file mic.h.

Function Documentation

MICInit()

MICHandle MICInit	(	MICInstance	instance,
		int	unused,
		MICWorkMemory *	workMemory,
		MICError *	outError
	)

The second parameter to MICInit is unused, any value is valid.

MICOpen()

MICError MICOpen

(

MICHandle

handle

)

MICGetState()

MICError MICGetState	(	MICHandle	handle,
		int	state,
		uint32_t *	outStateVal
	)

MICSetState()

MICError MICSetState	(	MICHandle	handle,
		int	state,
		uint32_t	stateVal
	)

MICGetStatus()

MICError MICGetStatus	(	MICHandle	handle,
		MICStatus *	outStatus
	)

MICSetDataConsumed()

MICError MICSetDataConsumed	(	MICHandle	handle,
		int	dataAmountConsumed
	)

MICClose()

MICError MICClose

(

MICHandle

handle

)

MICUninit()

MICError MICUninit

(

MICHandle

handle

)