USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Library Interface > d) Data Types and Constants > USB_HOST_AUDIO_V1_0_StreamOpen Macro
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_0_StreamOpen Macro

This function will open the specified audio stream. Once opened, the audio stream can be accessed via the handle which this function returns. The audioStreamObj parameter is the value returned in the USB_HOST_AUDIO_V1_0_StreamGetFirst or USB_HOST_AUDIO_V1_0_StreamGetNext functions.

C
#define USB_HOST_AUDIO_V1_0_StreamOpen USB_HOST_AUDIO_V1_StreamOpen
Preconditions

The audio stream object should be valid.

Parameters
Parameters 
Description 
audioStreamObj 
Audio stream object 
Returns

This function will return a valid handle if the audio stream could be opened successfully; otherwise, it will return USB_HOST_AUDIO_V1_0_STREAM_RESULT_HANDLE_INVALID. The function will return a valid handle if the stream is ready to be opened.

Remarks

None.