USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Library Interface > a) Audio Device Access Functions > USB_HOST_AUDIO_V1_EntityRequestCallbackSet Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_EntityRequestCallbackSet Function

This function registers a callback function for the Audio v1.0 control entity requests. The Audio v1.0 Host Client Driver will call this callback function when an audio entity control request is completed.

C
USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_EntityRequestCallbackSet(
    USB_HOST_AUDIO_V1_OBJ audioDeviceObj, 
    USB_HOST_AUDIO_V1_ENTITY_REQUEST_CALLBACK appAudioEntityRequestCallback, 
    uintptr_t context
);
Preconditions

None.

Parameters
Parameters 
Description 
audioDeviceObj 
Audio v1.0 device object. 
appAudioEntityRequestCallback 
A pointer to event handler function. If NULL, events will not be generated. 
context 
Application specific context that is returned in the event handler. 
Returns
  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The operation was successful
  • USB_HOST_AUDIO_V1_RESULT_OBJ_INVALID - The specified audio object does not exist
  • USB_HOST_AUDIO_V1_RESULT_FAILURE - An unknown failure occurred
Remarks

None.