自定义设置界面
ConfigSettingWindow
接口描述
该接口用于自定义设置界面中各标签页和功能区的显示隐藏,若未进行设置,则默认都显示
注意事项
- 该接口必须在设置界面打开前调用,设置界面打开时调用不会即时生效。
- 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
方法定义
1
|
HWM_SDK_AGENT_API hwmsdk::HwmErrCode ConfigSettingWindow(const HwmSettingWindowConfig * configInfo); |
回调函数
1
|
virtual void OnConfigSettingWindowResult(hwmsdk::HwmErrCode ret, const char* reason) {}; |
参数描述
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
configInfo |
是 |
HwmSettingWindowConfig |
设置窗口定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
normalTab |
HwmNormalSettingTab |
基本设置页定制信息。 |
videoTab |
HwmVideoSettingTab |
视频设置页定制信息。 |
audioTab |
HwmAudioSettingTab |
音频设置页定制信息。 |
screenTab |
HwmScreenSettingTab |
屏幕设置页定制信息。 |
recordTab |
HwmRecordSettingTab |
录制设置页定制信息。 |
virtualBackgroudTab |
HwmVirtualBackgroudSettingTab |
虚拟背景设置页定制信息。 |
hotkeyTab |
HwmHotKeySettingTab |
快捷键设置页定制信息 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
callOrConfArea |
HwmSettingArea |
会议呼叫设置区域定制信息。 |
chatNotifyArea |
HwmSettingArea |
聊天消息提醒设置区域定制信息。 |
subtitleArea |
HwmSettingArea |
字幕设置区域定制信息。 |
shareArea |
HwmSettingArea |
共享设置区域定制信息 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
cameraArea |
HwmSettingArea |
摄像头设置区域定制信息。 |
videoViewArea |
HwmSettingArea |
视频画面设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
micArea |
HwmSettingArea |
麦克风设置区域定制信息。 |
spkArea |
HwmSettingArea |
扬声器设置区域定制信息。 |
advancedArea |
HwmSettingArea |
高级设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
dualScreenArea |
HwmSettingArea |
双屏设置区域定制信息。 |
displayTopologyArea |
HwmSettingArea |
显示器显示模式设置区域定制信息。 |
swapContentArea |
HwmSettingArea |
切换显示内容设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
localRecordArea |
HwmSettingArea |
本地录制设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
virtualBackgroudArea |
HwmSettingArea |
虚拟背景设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
hotkeyArea |
HwmSettingArea |
快捷键设置区域定制信息。 |
参数 |
类型 |
描述 |
---|---|---|
isHide |
bool |
是否隐藏。 |
返回值
类型 |
描述 |
---|---|
HwmErrCode |
成功返回0,其他值表示失败。失败返回值见错误码参考。 |
示例代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/** * 定制设置界面 */ 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; } } |