USBMICGetState

Syntax

#include <cafe/usb_mic.h>

int USBMICGetState(usb_mic_handle_t h_mic, usb_mic_state_t state, unsigned int* p_value);

Parameters

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.
state An enumerated value of type usb_mic_state_t that specifies which UAC device state variable to get.
p_value A pointer to an unsigned int variable that will receive the value of the requested state variable, cast as an unsigned int.

Return Values

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

Description

This function is used to query UAC device state, such as current gain.

This function takes several milliseconds to complete, although much of that time is spent waiting on synchronization objects. It is not recommended to call this function from a timing sensitive thread.

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

USBMICInit
usb_mic_state_t
usb_mic_handle_t
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.


CONFIDENTIAL