3.3.4.2 USB_HOST_AUDIO_V1_ControlEntityGetFirst Function

C

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_ControlEntityGetFirst(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    USB_HOST_AUDIO_V1_CONTROL_ENTITY_OBJ * pEntityObject
);

Summary

This function retrieves the handle to the first audio control entity.

Parameters

Parameters Description
audioObj USB Host Audio v1.0 device object.
pEntityObject pointer to the Audio control entity handle.

Returns

  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The operation was successful
  • USB_HOST_AUDIO_V1_RESULT_END_OF_CONTROL_ENTITY - No more audio control entities are available
  • USB_HOST_AUDIO_V1_RESULT_OBJ_INVALID - The specified audio stream does not exist
  • USB_HOST_AUDIO_V1_RESULT_FAILURE - An unknown failure occurred

Remarks

None.