USB Microphone API Functions

Function Description
mem_res_query_t DEPRECATED Was used with USBMICOpenQuery and USBMICOpen to define the memory resource requirements to successfully open a UAC device instance.
mem_res_t DEPRECATED Was used with USBMICOpenQuery and USBMICOpen to define the memory resource requirements to successfully open a UAC device instance.
usb_event_handler_t Called in response to the events enumerated in usb_event_type_t. This event handler is called for all events of all UAC devices.
usb_mic_handle_t Issued by the UAC microphone library when a UAC microphone is attached and the application is notified via usb_event_handler_t. It is used to reference that UAC device in USB microphone library API calls.
usb_mic_ringbuffer_t This data structure defines the ringbuffer that receives the PCM data stream from the USB microphone.
usb_mic_state_t This enumeration defines the various side band parameters that can be adjusted or queried in the USB microphone subsystem.
usb_mic_status_t This data structure defines available data and their location with respect to the ringbuffer.
USBMICClose Stops all streaming and closes the USB UAC stack. All resources in calling USBMICOpen are released upon successful return from this function.
USBMICGetState Queries UAC device state, such as current gain.
USBMICGetStatus Returns the current status of the ring buffer that is shared between the USB UAC microphone library and the application.
USBMICInit Called once to initialize the UAC stack and to register an event callback function. Subsequent events are sent from the UAC stack to the application via this callback.
USBMICOpen Prepares the USB UAC stack and puts it into a state of readiness.
USBMICOpenQuery DEPRECATED This function is now deprecated and need no longer be called.
USBMICSetDataConsumed Updates the ring buffer state in the USB UAC library. The count is in samples, not bytes.
USBMICSetState Sets UAC device state, such as current gain.
USBMICStart Starts streaming PCM data into the ring buffer that was provided to the USB UAC stack with USBMICOpen until USBMICStop is called.
USBMICStop Stops streaming PCM data into the ring buffer that was provided to the USB UAC stack with USBMICOpen.
USBMICUninit Deactivates and shuts down the UAC stack. Typically called in the process of an orderly UAC stack shutdown.

Revision History

2013/05/08 Automated cleanup pass.
2013/04/24 Initial version


CONFIDENTIAL