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_EventHandlerSetThis function registers an event handler for the specified Audio function driver instance.
USB_DEVICE_AUDIO_V2_ReadThis function requests a data read from the USB Device Audio v2.0 Function Driver Layer.
USB_DEVICE_AUDIO_V2_TransferCancelThis function cancels a scheduled Audio v2.0 Device data transfer.
USB_DEVICE_AUDIO_V2_WriteThis 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_EVENTUSB Device Audio v2.0 Function Driver events.
USB_DEVICE_AUDIO_V2_EVENT_DATA_READ_COMPLETEUSB Device Audio Function Driver Audio v2.0 read and write complete event data.
USB_DEVICE_AUDIO_V2_EVENT_DATA_SET_ALTERNATE_INTERFACEUSB Device Audio v2.0 Function Driver alternate interface setting event data.
USB_DEVICE_AUDIO_V2_EVENT_DATA_WRITE_COMPLETEUSB Device Audio Function Driver Audio v2.0 read and write complete event data.
USB_DEVICE_AUDIO_V2_EVENT_HANDLERUSB Device Audio v2.0 Event Handler Function Pointer Type.
USB_DEVICE_AUDIO_V2_EVENT_RESPONSEUSB Device Audio v2.0 Function Driver event callback response type.
USB_DEVICE_AUDIO_V2_INDEXUSB Device Audio v2.0 Function Driver index.
USB_DEVICE_AUDIO_V2_INITUSB Device Audio v2.0 Function Driver initialization data structure.
USB_DEVICE_AUDIO_V2_RESULTUSB Device Audio Function Driver USB Device Audio v2.0 result enumeration.
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLEUSB Device Audio v2.0 Function Driver Transfer Handle Definition.
USB_DEVICE_AUDIO_V2_EVENT_RESPONSE_NONEUSB Device Audio v2.0 Function Driver event handler response type none.
USB_DEVICE_AUDIO_V2_FUNCTION_DRIVERUSB Device Audio v2.0 Function Driver function pointer.
USB_DEVICE_AUDIO_V2_TRANSFER_HANDLE_INVALIDUSB Device Audio v2.0 Function Driver Invalid Transfer Handle Definition.