MICUninit

Syntax

#include <cafe/mic.h>

int MICUninit(mic_handle_t h_mic);

Parameters

h_mic Handle returned from MICInit.

Return Values

A return value of MIC_ERROR_NONE (0) indicates success and any other value indicates an error.

MIC_ERROR_INV_ARG is returned if an invalid handle is passed in. MIC_ERROR_NOT_INIT is returned when the MICUninit is called before MICInit.

Description

This function is the counterpart to MICInit. It will unconditionally shut down the DRC microphone driver stack. The functionality of MICClose is performed, if necessary, before uninitializing the driver stack.

After being uninitialized, the ring buffer will no longer be referenced by the DRC microphone library and the application can safely free or reuse that memory.

The processing performed in MICUninit is synchronous in the sense that this function will not return until the DRC microphone driver stack is shut down and quiescent. This can take tens of milliseconds although much of that time is spent waiting on synchronization objects. This function is not meant to be called from a timing sensitive thread.

Do Not Call From

Background Do not call this function from the background.
Multiple threads This function is not thread-safe.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

MICInit
mic_handle_t
Error Codes

Revision History

2013/05/08 Automated cleanup pass.
2012/06/08 Initial version.


CONFIDENTIAL