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_EntityObjectGet Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_EntityObjectGet Function

This function retrieves the entity object for the entity ID.

C
USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_EntityObjectGet(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    uint8_t entityId, 
    USB_HOST_AUDIO_V1_CONTROL_ENTITY_OBJ* entityObj
);
Parameters
Parameters 
Description 
audioObj 
USB Host Audio v1.0 Device object 
entityId 
Entity ID 
entityObject 
Audio control entity object 
Returns
  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The operation was successful
  • USB_HOST_AUDIO_V1_RESULT_FAILURE - The entity Id could not be found or an unknown failure occurred
Remarks

None.