Customizing the Settings Screen
ConfigSettingWindow
API Description
This API is used to customize the display of tab pages and function areas of the settings screen. If not customized, all tab pages and function areas are displayed by default.
Precautions
- This API must be called before the setting screen is opened. Calling this API when the setting screen is opened does not take effect immediately.
- 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 ConfigSettingWindow(const HwmSettingWindowConfig * configInfo); |
Callback Function
1
|
virtual void OnConfigSettingWindowResult(hwmsdk::HwmErrCode ret, const char* reason) {}; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
configInfo |
Yes |
HwmSettingWindowConfig |
Settings screen customization information. |
Parameter |
Type |
Description |
---|---|---|
normalTab |
HwmNormalSettingTab |
Customization information about the basic settings screen. |
videoTab |
HwmVideoSettingTab |
Customization information about the video settings screen. |
audioTab |
HwmAudioSettingTab |
Customization information about the audio settings screen. |
screenTab |
HwmScreenSettingTab |
Customization information about the screen settings screen. |
recordTab |
HwmRecordSettingTab |
Customization information about the recording settings screen. |
virtualBackgroudTab |
HwmVirtualBackgroudSettingTab |
Customization information about the virtual background settings screen. |
hotkeyTab |
HwmHotKeySettingTab |
Customization information about the shortcut key settings screen. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
callOrConfArea |
HwmSettingArea |
Calling settings area customization information. |
chatNotifyArea |
HwmSettingArea |
Message notifications settings area customization information. |
subtitleArea |
HwmSettingArea |
Captions settings area customization information. |
shareArea |
HwmSettingArea |
Screen sharing settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
cameraArea |
HwmSettingArea |
Camera settings area customization information. |
videoViewArea |
HwmSettingArea |
Video settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
micArea |
HwmSettingArea |
Microphone settings area customization information. |
spkArea |
HwmSettingArea |
Speaker settings area customization information. |
advancedArea |
HwmSettingArea |
Advanced settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
dualScreenArea |
HwmSettingArea |
Customization information about the dual screen setting area. |
displayTopologyArea |
HwmSettingArea |
Customization information about the display mode setting area. |
swapContentArea |
HwmSettingArea |
Customization information about the area of switching the display content. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
localRecordArea |
HwmSettingArea |
Local recording settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
virtualBackgroudArea |
HwmSettingArea |
Virtual background settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
hotkeyArea |
HwmSettingArea |
Shortcut key settings area customization information. |
Parameter |
Type |
Description |
---|---|---|
isHide |
bool |
Whether to hide. |
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 13 14 15 16 17 |
/** * Customize the settings screen. */ void demoConfigSettingWindowDlg::OnBnClickedOk() { hwmsdkagent::HwmSettingWindowConfig data{ 0 }; data.normalTab.isHide = true; data.videoTab.videoViewArea.isHide = true; int ret = hwmsdkagent::ConfigSettingWindow(&data); if (hwmsdk::HWM_COMMON_SUCCESS != ret) { AfxMessageBox(_T("config setting window error")); return; } } |
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