2.3.4 Library Interface

This section describes the Application Programming Interface (API) functions of the USB Device Audio 1.0 Library.

Refer to each section for a detailed description.

a) Functions

Name Description
USB_DEVICE_AUDIO_EventHandlerSet This function registers an event handler for the specified Audio function driver instance.
USB_DEVICE_AUDIO_Read This function requests a data read from the USB Device Audio Function Driver Layer.
USB_DEVICE_AUDIO_TransferCancel This function cancels a scheduled Audio Device data transfer.
USB_DEVICE_AUDIO_Write This function requests a data write to the USB Device Audio Function Driver Layer.
USB_DEVICE_AUDIO_StatusSend This function requests a Status write to the USB Device Audio Function Driver Layer.

b) Data Types and Constants

Name Description
USB_DEVICE_AUDIO_INDEX USB Device Audio function driver index.
USB_DEVICE_AUDIO_TRANSFER_HANDLE USB Device Audio Function Driver transfer handle definition.
USB_DEVICE_AUDIO_EVENT USB Device Audio Function Driver events.
USB_DEVICE_AUDIO_RESULT USB Device Audio Function Driver USB Device Audio result enumeration.
USB_DEVICE_AUDIO_TRANSFER_HANDLE_INVALID USB Device Audio Function Driver invalid transfer handle definition.
USB_DEVICE_AUDIO_EVENT_DATA_READ_COMPLETE USB Device Audio Function Driver audio read and write complete event data.
USB_DEVICE_AUDIO_EVENT_DATA_WRITE_COMPLETE USB Device Audio Function Driver audio read and write complete event data.
USB_DEVICE_AUDIO_EVENT_HANDLER USB Device Audio event handler function pointer type.
USB_DEVICE_AUDIO_EVENT_RESPONSE USB Device Audio Function Driver event callback response type.
USB_DEVICE_AUDIO_EVENT_RESPONSE_NONE USB Device Audio Function Driver event handler response type none.
USB_DEVICE_AUDIO_FUNCTION_DRIVER USB Device Audio Function Driver function pointer.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_CUR This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_CUR.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MAX This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MAX.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MEM This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MEM.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MIN This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MIN.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_RES This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_RES.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_CUR USB Device Audio Function Driver set and get request data.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MAX This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MAX.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MEM This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MEM.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MIN This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MIN.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_RES This is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_RES.
USB_DEVICE_AUDIO_EVENT_DATA_ENTITY_GET_STAT This is type USB_DEVICE_AUDIO_EVENT_DATA_ENTITY_GET_STAT.
USB_DEVICE_AUDIO_EVENT_DATA_INTERFACE_SETTING_CHANGED USB Device Audio Function Driver alternate interface setting event data.
USB_DEVICE_AUDIO_INIT USB Device Audio Function Driver initialization data structure.
USB_DEVICE_AUDIO_EVENT_DATA_STATUS_SEND_COMPLETE USB Device Audio Function Driver Status Send complete event data.