#include <cafe/usb_mic.h>

int USBMICGetStatus(usb_mic_handle_t h_mic, usb_mic_status_t* p_status);


h_mic Instance handle returned via usb_event_data_t data structure through the event handler of type usb_event_handler_t that is provided as an argument to USBMICInit and will contain a valid instance handle when the USB microphone is attached.
p_status Pointer to a structure of type usb_mic_status_t that will receive the current status of the ring buffer.

Return Values

A value of zero indicates success and any other value the type of error that was encountered.


Calling this function will return the current status of the ring buffer that is shared between the USB UAC microphone library and the application. The reading of the status variables is protected with a mutex assuring that all structure elements are coherent with one another.

This function is designed to be callable from a timing sensitive thread such as an AX callback function.

Do Not Call From

Background Do not call this function from the background.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

Error Codes

Revision History

2013/05/08 Automated cleanup pass.
2012/08/03 Cleanup Pass
2012/07/05 Update for SDK2.06
2012/01/05 Initial version.