Enabling a Function
EnableFeature
API Description
This API is used to enable or disable a function in the Windows SDK.
Precautions
- Functions have default statuses. Call this API only if you need to change the function status.
- This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.
Method Definition
1
|
HWM_SDK_AGENT_API hwmsdk::HwmErrCode EnableFeature(HwmEnableFeatureType type, bool isEnable); |
Callback Function
1
|
virtual void OnEnableFeature(hwmsdk::HwmErrCode ret, const char* msg) {}; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
HwmEnableFeatureType |
Function switch. |
isEnable |
Yes |
bool |
Function switch status. |
Enumerated Value |
Description |
---|---|
HWM_ENABLE_FEATURE_TYPE_MULTI_MONITOR |
Whether to enable the multi-monitor mode. In the multi-monitor scenario, when one monitor screen is shared, the video screen is displayed on the other monitor. In single-monitor mode, the video window is hidden after sharing is enabled. This function is disabled by default. |
HWM_ENABLE_FEATURE_TYPE_SHOW_HANGUP_ATTENDEE |
Whether to display the status of the participant who leaves the meeting in the participant list. This function is enabled by default. |
HWM_ENABLE_FEATURE_TYPE_HOWLING_DETECTION |
Whether to enable feedback suppression. This function is enabled by default. |
HWM_ENABLE_FEATURE_TYPE_HIGH_RESOLUTION |
Whether to enable 1080p HD display in a meeting. This function is enabled by default. |
HWM_ENABLE_FEATURE_TYPE_MIC_SWITCH |
Initial status of the microphone in a meeting. The microphone is enabled by default. |
HWM_ENABLE_FEATURE_TYPE_CAM_SWITCH |
Initial status of the camera in a meeting. The camera is disabled by default. |
HWM_ENABLE_FEATURE_TYPE_HIDE_EXTERNAL_LABEL |
Whether an external label is displayed or hidden in a meeting. By default, the external label is displayed. |
HWM_ENABLE_FEATURE_AUTO_MIC_VOLUME |
Whether to enable automatic microphone volume adjustment. This function is enabled by default. If the external microphone has automatic gain control (AGC), you are advised to disable this function. |
HWM_ENABLE_FEATURE_BREAKOUT_CONF |
Status of the breakout room function. This function is enabled by default. |
HWM_ENABLE_FEATURE_CONFIRM_RECORD |
Whether to display the recording confirmation prompt. This function is disabled by default. |
HWM_ENABLE_FEATURE_DEFAULT_SHARE_AUDIO |
Audio sharing. This function is disabled by default. |
HWM_ENABLE_FEATURE_SUPPORT_DISCONNECT_AUDIO |
Disconnecting audio. This function is disabled by default. |
HWM_ENABLE_FEATURE_DISCONNECT_AUDIO_TO_JOIN_CONF |
Joining a meeting without audio. This function is disabled by default. |
HWM_ENABLE_FEATURE_CPU_REDUCTION_DETECT |
Detecting CPU frequency reduction. This function is disabled by default. |
HWM_ENABLE_FEATURE_SUPPORT_GUEST_INVITE |
Inviting participants. This function is disabled by default. |
Return Values
Type |
Description |
---|---|
HwmErrCode |
If 0 is returned, the operation is successful. If other values are returned, the operation fails. For details about values returned upon failures, see Common Error Codes. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 |
/** * Configure multi-monitor mode status. */ void demoEnableFeatureDlg::OnBnClickedButtonMultiMonitor() { bool isCheck = true; int ret = hwmsdkagent::EnableFeature(hwmsdkagent::HWM_ENABLE_FEATURE_TYPE_MULTI_MONITOR, isCheck); if (hwmsdk::HWM_COMMON_SUCCESS != ret) { AfxMessageBox(_T("Enable multi monitor failed")); } } |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot