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_0_StreamGetNext Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_0_StreamGetNext Function

This function returns information about next audio stream in the specified Audio stream group. The USB_HOST_AUDIO_V1_0_StreamGetFirst function should have been called at least once on the same audio stream group before calling this function. Then, calling this function repeatedly on the stream group will return information about the next audio stream in the stream group. When there are no more audio streams to report, the function returns USB_HOST_AUDIO_V1_0_RESULT_END_OF_STREAM_LIST. 

Calling the USB_HOST_AUDIO_V1_0_StreamGetFirst function on the stream group index after the USB_HOST_AUDIO_V1_0_StreamGetNext function has been called will cause the Audio v1.0 Client Driver to reset the audio stream group to point to the first stream in the stream group.

C
USB_HOST_AUDIO_V1_0_RESULT USB_HOST_AUDIO_V1_0_StreamGetNext(
    USB_HOST_AUDIO_V1_0_STREAM_OBJ audioStreamObj, 
    USB_HOST_AUDIO_V1_0_STREAM_INFO * streamInfo
);
Preconditions

The USB_HOST_AUDIO_V1_0_StreamGetFirst function must have been called before calling this function.

Parameters
Parameters 
Description 
audioStreamObj 
Present audio stream object 
streamInfo 
Pointer to the streamInfo object 
Returns
  • USB_HOST_AUDIO_V1_0_STREAM_RESULT_SUCCESS - The operation was successful
  • USB_HOST_AUDIO_V1_0_RESULT_OBJ_INVALID - The specified Audio v1.0 client driver object does not exist
  • USB_HOST_AUDIO_V1_0_STREAM_RESULT_FAILURE - An unknown failure occurred
  • USB_HOST_AUDIO_V1_0_RESULT_END_OF_STREAM_LIST - There are no more audio streams in the stream group
Remarks

None.