3.3.4.41 USB_HOST_AUDIO_V1_StreamSamplingFrequencyGet Function

C

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_StreamSamplingFrequencyGet(
    USB_HOST_AUDIO_V1_STREAM_HANDLE streamHandle, 
    USB_HOST_AUDIO_V1_REQUEST_HANDLE * requestHandle, 
    uint32_t * samplingFrequency
);

Summary

This function schedules an audio stream set sampling rate request for the specified audio stream. A USB_HOST_AUDIO_V1_STREAM_EVENT_SAMPLING_RATE_SET_COMPLETE event is generated when this request is completed. USB_HOST_AUDIO_V1_STREAM_EVENT_SAMPLING_RATE_SET_COMPLETE_DATA returns the status and request handle of the request.

Precondition

The audio stream should have been opened.

Parameters

Parameters Description
streamHandle Handle to the Audio v1.0 stream
requestHandle Handle to the stream set sampling rate request
samplingFrequency Pointer to the sampling rate

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.