Displaying the Settings Window
ShowSettingWindow
API Description
This API is used to display the settings window and can be called before and during a meeting.
Precautions
- 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 ShowSettingWindow(const HwmShowSettingWindowInfo* showInfo); |
Callback Function
1
|
virtual void OnShowSettingWindowResult(hwmsdk::HwmErrCode ret, const char* reason) {}; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
showInfo |
Yes |
HwmShowSettingWindowInfo |
Information about displaying the settings window. |
Parameter |
Type |
Description |
---|---|---|
isShow |
bool |
Whether the window is displayed. |
defaultPage |
HwmSettingPage |
Tab displayed by default. |
Enumerated Value |
Description |
---|---|
SETTING_PAGE_NORMAL |
General |
SETTING_PAGE_VIDEO |
Video |
SETTING_PAGE_AUDIO |
Audio |
SETTING_PAGE_RECORD |
Recording |
SETTING_PAGE_HOTKEY |
Shortcut keys |
SETTING_PAGE_SCREEN |
Screen |
SETTING_PAGE_COUNT |
Number of setting screens. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/** * Displays the settings window. */ void demoShowSettingWindowDlg::OnBnClickedOk() { hwmsdkagent::HwmShowSettingWindowInfo showInfo{ 0 }; showInfo.isShow = true; showInfo.defaultPage = hwmsdkagent::HwmSettingPage::SETTING_PAGE_NORMAL; int ret = hwmsdkagent::ShowSettingWindow(&showInfo); if (hwmsdk::HWM_COMMON_SUCCESS != ret) { AfxMessageBox(_T("show 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