3.3.4.9 USB_HOST_AUDIO_V1_FeatureUnitChannelMuteGet Function

C

USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_FeatureUnitChannelMuteGet(
    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 get 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 request. 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

Returns

Remarks

None.