USB_HOST_AUDIO_V1_ControlEntityGetFirst Function

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

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_ControlEntityGetFirst(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    USB_HOST_AUDIO_V1_CONTROL_ENTITY_OBJ * pEntityObject
);

Preconditions

None.

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.

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_ControlEntityGetFirst Function

MPLAB Harmony USB Stack

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support