3.3.4.39 USB_HOST_AUDIO_V1_StreamOpen Function

C

USB_HOST_AUDIO_V1_STREAM_HANDLE USB_HOST_AUDIO_V1_StreamOpen(
    USB_HOST_AUDIO_V1_STREAMING_INTERFACE_OBJ audiostreamingInterfaceObj
);

Summary

This function will open the specified audio stream. Once opened, the audio stream can be accessed via the handle that this function returns. The audiostreamingInterfaceObj parameter is the value returned in the USB_HOST_AUDIO_V1_StreamingInterfaceGetFirst or USB_HOST_AUDIO_V1_StreamingInterfaceGetNext functions.

Precondition

The audio streaming interface object should be valid.

Parameters

Returns

Will return a valid handle if the audio stream could be opened successfully. Otherwise, USB_HOST_AUDIO_V1_RESULT_HANDLE_INVALID is returned. The function will return a valid handle if the stream is ready to be opened.

Remarks

None.