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_StreamingInterfaceSet Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_StreamingInterfaceSet Function

This function schedules an audio stream enable request for the specified audio stream. An audio stream must be enable before scheduling any data transfer with the stream. A USB_HOST_AUDIO_V1_STREAM_EVENT_ENABLE_COMPLETE event is generated when this request is completed. USB_HOST_AUDIO_V1_STREAM_EVENT_ENABLE_COMPLETE_DATA returns the status and request handle of the request.

C
USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_StreamingInterfaceSet(
    USB_HOST_AUDIO_V1_STREAM_HANDLE streamHandle, 
    USB_HOST_AUDIO_V1_REQUEST_HANDLE * requestHandle, 
    USB_HOST_AUDIO_V1_STREAMING_INTERFACE_SETTING_OBJ interfaceSettingObj
);
Preconditions

The audio stream should have been opened. Only one audio stream from an audio stream group can be enabled at a time.

Parameters
Parameters 
Description 
streamHandle 
Handle to the Audio v1.0 stream. 
requestHandle 
Handle to the stream enable request. 
Returns
  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The operation was successful
  • USB_HOST_AUDIO_V1_RESULT_HANDLE_INVALID - The specified audio stream does not exist
  • USB_HOST_AUDIO_V1_RESULT_FAILURE - An unknown failure occurred
Remarks

None.