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_StreamingInterfaceSettingGetFirst Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_StreamingInterfaceSettingGetFirst Function

This function gets the first streaming interface setting object within an audio streaming interface.

C
USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_StreamingInterfaceSettingGetFirst(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    USB_HOST_AUDIO_V1_STREAMING_INTERFACE_OBJ streamingInterfaceObj, 
    USB_HOST_AUDIO_V1_STREAMING_INTERFACE_SETTING_OBJ * interfaceSettingObj
);
Preconditions

The Audio v1.0 Device should have been attached.

Parameters
Parameters 
Description 
audioObj 
Audio device object. 
streamingInterfaceObj 
Audio streaming interface object. 
interfaceSettingObj 
Pointer to the audio streaming interface setting object. 
Returns
  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The request completed successfully
  • USB_HOST_AUDIO_V1_RESULT_END_OF_INTERFACE_SETTINGS - No more streaming interface settings 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.