USB_HOST_AUDIO_V1_StreamingInterfaceGetFirst Function

This function will get the first streaming interface object from the attached Audio Device.

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_StreamingInterfaceGetFirst(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    USB_HOST_AUDIO_V1_STREAMING_INTERFACE_OBJ* streamingInterfaceObj
);

Preconditions

The Audio v1.0 Device should have been attached.

Parameters

Parameters	Description
audioObj	Audio v1.0 client driver object.
streamingInterfaceObj	Pointer to an audio streaming interface object.

Returns

USB_HOST_AUDIO_V1_RESULT_SUCCESS - The request completed successfully
USB_HOST_AUDIO_V1_RESULT_END_OF_STREAMING_INTERFACE - No more streaming interfaces are available
USB_HOST_AUDIO_V1_RESULT_DEVICE_UNKNOWN - Device is not attached
USB_HOST_AUDIO_V1_RESULT_OBJ_INVALID - Audio Device object is invalid
USB_HOST_AUDIO_V1_RESULT_FAILURE - An error has occurred

Remarks

None.

USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Library Interface > b) Audio Stream Access Functions > USB_HOST_AUDIO_V1_StreamingInterfaceGetFirst Function

MPLAB Harmony USB Stack

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support