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

    
         HWM_SDK_AGENT_API hwmsdk::HwmErrCode ShowSettingWindow(const HwmShowSettingWindowInfo* showInfo);

Callback Function

    
         virtual void OnShowSettingWindowResult(hwmsdk::HwmErrCode ret, const char* reason) {};

Parameter Description

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
showInfo	Yes	HwmShowSettingWindowInfo	Information about displaying the settings window.

**Table 2** HwmShowSettingWindowInfo parameters
Parameter	Type	Description
isShow	bool	Whether the window is displayed.
defaultPage	HwmSettingPage	Tab displayed by default.

**Table 3** Enumerated values of HwmSettingPage
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

    
         /**
* 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;
    }
}