USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Library Interface > d) Data Types and Constants > USB_HOST_AUDIO_V1_ATTACH_EVENT_HANDLER Type
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_ATTACH_EVENT_HANDLER Type

USB Host Audio v1.0 Client Driver Attach Event Handler Function Pointer Type. 

This data type defines the required function signature of the USB Host Audio v1.0 Client Driver attach event handling callback function. The application must register a pointer to the Audio v1.0 Client Driver attach events handling function whose function signature (parameter and return value types) match the types specified by this function pointer to receive attach and detach events callbacks from the Audio v1.0 Client Driver. The application should use the USB_HOST_AUDIO_V1_AttachEventHandlerSet function to register an attach event handler. The client driver will call this function with the relevant event parameters. The descriptions of the event handler function parameters are as follows:

  • audioObj - Audio Device object to which this event is directed
  • event - Event indicates if it is an Attach or Detach
  • context - Value identifying the context of the application that was registered with the event handling function
C
typedef void (* USB_HOST_AUDIO_V1_ATTACH_EVENT_HANDLER)(USB_HOST_AUDIO_V1_OBJ audioObj, USB_HOST_AUDIO_V1_EVENT event, uintptr_t context);
Remarks

None.