3.3.4.10 USB_HOST_AUDIO_V1_FeatureUnitChannelMuteSet Function

C 

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_FeatureUnitChannelMuteSet(
    USB_HOST_AUDIO_V1_OBJ audioObj, 
    USB_HOST_AUDIO_V1_CONTROL_ENTITY_OBJ entityObject, 
    USB_HOST_AUDIO_V1_REQUEST_HANDLE * requestHandle, 
    uint8_t channelNumber, 
    bool * muteStatus
);

Summary

This function schedules a set mute control request to the specified channel. Prior to calling this function the user should check if mute control exists on the specified channel by calling the USB_HOST_AUDIO_V1_FeatureUnitChannelMuteExists function.

If the request was scheduled successfully, the requestHandle parameter will contain a request handle that uniquely identifies this transfer. If the transfer could not be scheduled successfully, requestHandle will contain USB_HOST_AUDIO_V1_REQUEST_HANDLE_INVALID.

When the control request completes, the Audio v1.0 Client Driver will call the callback function that was set using the USB_HOST_AUDIO_V1_EntityRequestCallbackSet function. The context parameter specified here will be returned in the callback.

Precondition

None.

Parameters

Parameters Description
audioObj USB Host Audio v1.0 Device object
entityObject Audio control entity object
requestHandle Output parameter that will contain the handle to this request
channelNumber Channel Number
muteStatus Value of mute control, where 1 mutes the channel and 0 removes unmutes

Returns

  • USB_HOST_AUDIO_V1_RESULT_SUCCESS - The request was scheduled successfully. requestHandle will contain a valid request handle.
  • USB_HOST_AUDIO_V1_RESULT_BUSY - The control request mechanism is currently busy. Retry the request.
  • USB_HOST_AUDIO_V1_RESULT_FAILURE - An unknown failure occurred. requestHandle will contain USB_HOST_AUDIO_V1_0_REQUEST_HANDLE_INVALID.
  • USB_HOST_AUDIO_V1_RESULT_PARAMETER_INVALID - The data pointer or requestHandle pointer is NULL.

Remarks

None.