2.4.5 Library Interface

Library Interface

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

Refer to each section for a detailed description.

a) Functions

Name Description
USB_DEVICE_AUDIO_V2_EventHandlerSet This function registers an event handler for the specified Audio function driver instance.
USB_DEVICE_AUDIO_V2_Read This function requests a data read from the USB Device Audio v2.0 Function Driver Layer.
USB_DEVICE_AUDIO_V2_TransferCancel This function cancels a scheduled Audio v2.0 Device data transfer.
USB_DEVICE_AUDIO_V2_Write This function requests a data write to the USB Device Audio v2.0 Function Driver Layer.

b) Data Types and Constants

Name Description
USB_DEVICE_AUDIO_V2_EVENT USB Device Audio v2.0 Function Driver events.
USB_DEVICE_AUDIO_V2_EVENT_DATA_READ_COMPLETE USB Device Audio Function Driver Audio v2.0 read and write complete event data.
USB_DEVICE_AUDIO_V2_EVENT_DATA_SET_ALTERNATE_INTERFACE USB Device Audio v2.0 Function Driver alternate interface setting event data.
USB_DEVICE_AUDIO_V2_EVENT_DATA_WRITE_COMPLETE USB Device Audio Function Driver Audio v2.0 read and write complete event data.
USB_DEVICE_AUDIO_V2_EVENT_HANDLER USB Device Audio v2.0 Event Handler Function Pointer Type.
USB_DEVICE_AUDIO_V2_EVENT_RESPONSE USB Device Audio v2.0 Function Driver event callback response type.
USB_DEVICE_AUDIO_V2_INDEX USB Device Audio v2.0 Function Driver index.
USB_DEVICE_AUDIO_V2_INIT USB Device Audio v2.0 Function Driver initialization data structure.
USB_DEVICE_AUDIO_V2_RESULT USB Device Audio Function Driver USB Device Audio v2.0 result enumeration.
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLE USB Device Audio v2.0 Function Driver Transfer Handle Definition.
USB_DEVICE_AUDIO_V2_EVENT_RESPONSE_NONE USB Device Audio v2.0 Function Driver event handler response type none.
USB_DEVICE_AUDIO_V2_FUNCTION_DRIVER USB Device Audio v2.0 Function Driver function pointer.
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLE_INVALID USB Device Audio v2.0 Function Driver Invalid Transfer Handle Definition.