Microphone Error Codes

Syntax

/*
 * Error Codes
 */
#define MIC_ERROR_NONE          0
#define MIC_ERROR_NOT_SUP       (-1)
#define MIC_ERROR_INV_ARG       (-2)
#define MIC_ERROR_INV_STATE     (-3)
#define MIC_ERROR_NO_MEM        (-4)
#define MIC_ERROR_ALREADY_OPEN  (-5)
#define MIC_ERROR_NOT_OPEN      (-6)
#define MIC_ERROR_NOT_INIT      (-7)
#define MIC_ERROR_NOT_CONNECTED (-8)

Elements

MIC_ERROR_NONE No error occurred performing the requested function.
MIC_ERROR_NOT_SUP This code is returned in the context of setting or getting state. It means that the requested subfunction is not supported. It is an indication of a program error.
MIC_ERROR_INV_ARG This code is returned whenever an invalid argument is provided in a DRC microphone API call. It is an indication of a program error.
MIC_ERROR_INV_STATE This code is returned whenever the internal driver state does not permit the requested function to be performed. It is an indication of a program error.
MIC_ERROR_NO_MEM Internal error, not returned by any API.
MIC_ERROR_ALREADY_OPEN This error code is returned when a function such as MICOpen is called more than once without closing it first. This logic also applies to MICInit. It is an indication of a program error.
MIC_ERROR_NOT_OPEN This error code is returned when a USB microphone API is called out of sequence, such as calling MICSetState before calling MICInit. It is an indication of a program error.
MIC_ERROR_NOT_INIT Similar to MIC_ERROR_NOT_OPEN, but indicating that the driver stack is not yet initialized. It is an indication of a program error.
MIC_ERROR_NOT_CONNECTED This error code indicates that the connection with the DRC has been lost.
-85 There is no publicly visible symbolic name for this error code. It is returned from MICInit if the provided ring buffer is too small. The hard-coded minimum ring buffer size is 3088 bytes.

See Also

MICInit
MICOpen
MICGetState
MICSetState

Revision History

2013/05/08 Automated cleanup pass.
2012/10/19 Initial version.


CONFIDENTIAL