Jump to main content

##

# 3.3.4.5 USB_HOST_AUDIO_V1_EntityObjectGet Function

## 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
    );

## Summary

This function retrieves the entity object for the entity ID.

## Precondition

None.

## Parameters

Parameters | Description
audioObj | USB Host Audio v1.0 Device object
entityId | Entity ID
entityObj | 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.