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_EventHandlerSetThis function registers an event handler for the specified Audio function driver instance.
USB_DEVICE_AUDIO_ReadThis function requests a data read from the USB Device Audio Function Driver Layer.
USB_DEVICE_AUDIO_TransferCancelThis function cancels a scheduled Audio Device data transfer.
USB_DEVICE_AUDIO_WriteThis function requests a data write to the USB Device Audio Function Driver Layer.
USB_DEVICE_AUDIO_StatusSendThis function requests a Status write to the USB Device Audio Function Driver Layer.

b) Data Types and Constants

Name Description
USB_DEVICE_AUDIO_INDEXUSB Device Audio function driver index.
USB_DEVICE_AUDIO_TRANSFER_HANDLEUSB Device Audio Function Driver transfer handle definition.
USB_DEVICE_AUDIO_EVENTUSB Device Audio Function Driver events.
USB_DEVICE_AUDIO_RESULTUSB Device Audio Function Driver USB Device Audio result enumeration.
USB_DEVICE_AUDIO_TRANSFER_HANDLE_INVALIDUSB Device Audio Function Driver invalid transfer handle definition.
USB_DEVICE_AUDIO_EVENT_DATA_READ_COMPLETEUSB Device Audio Function Driver audio read and write complete event data.
USB_DEVICE_AUDIO_EVENT_DATA_WRITE_COMPLETEUSB Device Audio Function Driver audio read and write complete event data.
USB_DEVICE_AUDIO_EVENT_HANDLERUSB Device Audio event handler function pointer type.
USB_DEVICE_AUDIO_EVENT_RESPONSEUSB Device Audio Function Driver event callback response type.
USB_DEVICE_AUDIO_EVENT_RESPONSE_NONEUSB Device Audio Function Driver event handler response type none.
USB_DEVICE_AUDIO_FUNCTION_DRIVERUSB Device Audio Function Driver function pointer.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_CURThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_CUR.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MAXThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MAX.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MEMThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MEM.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MINThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_MIN.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_RESThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_GET_RES.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_CURUSB Device Audio Function Driver set and get request data.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MAXThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MAX.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MEMThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MEM.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MINThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_MIN.
USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_RESThis is type USB_DEVICE_AUDIO_EVENT_DATA_CONTROL_SET_RES.
USB_DEVICE_AUDIO_EVENT_DATA_ENTITY_GET_STATThis is type USB_DEVICE_AUDIO_EVENT_DATA_ENTITY_GET_STAT.
USB_DEVICE_AUDIO_EVENT_DATA_INTERFACE_SETTING_CHANGEDUSB Device Audio Function Driver alternate interface setting event data.
USB_DEVICE_AUDIO_INITUSB Device Audio Function Driver initialization data structure.
USB_DEVICE_AUDIO_EVENT_DATA_STATUS_SEND_COMPLETEUSB Device Audio Function Driver Status Send complete event data.