文档首页/ 华为云会议 Meeting/ 客户端SDK参考/ Windows SDK/ 接口参考/ 基础配置/ 设置虚拟背景默认图片
更新时间：2025-10-28 GMT+08:00
查看PDF
分享

设置虚拟背景默认图片

SetVirtualBackgroundDefaultImages

接口描述

该接口用于设置自定义虚拟背景默认图片。

注意事项

  1. 该接口为异步接口，返回值只代表接口是否调用成功，实际业务处理结果在对应的回调函数中返回。

方法定义

HWM_SDK_AGENT_API hwmsdk::HwmErrCode SetVirtualBackgroundDefaultImages(const HwmVirtualBackgroundInfo* defaultImagesInfo);

回调函数

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

参数描述

表1 结构体HwmVirtualBackgroundInfo参数说明

参数

是否必须

类型

描述

mode

是

HwmSettingVrbkDefaultImageMode

设置自定义虚拟背景默认图模式。

imageList

否

HwmVirtualBackgroundImageInfo*

虚拟背景图列表。

imageLength

否

unsigned int

虚拟背景图个数。
表2 枚举HwmSettingVrbkDefaultImageMode参数说明

枚举值

描述

HWM_SETTING_VRBK_DEFAULT_IMAGE_MODE_REPLACE_ALL

全部替换, 覆盖内置的默认图片。

HWM_SETTING_VRBK_DEFAULT_IMAGE_MODE_APPEND

基于内置的默认图片追加。
表3 结构体HwmVirtualBackgroundImageInfo参数说明

参数

是否必须

类型

描述

imagePath

是

HwmSettingVrbkDefaultImageMode

虚拟背景图片路径，使用绝对路径。如“to/path/image.png”，自定义图片口支持JPG、JPEG、PNG格式，最大分辨率为4096*4096，最小分辨率为160*160。

注：需要UTF8编码。

返回值

表4 返回值

类型

描述

HwmErrCode

成功返回0，其他值表示失败。失败返回值见错误码参考。

 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
 
/**
*  设置自定义虚拟背景默认图片
*/
void demoSetVirtualBackgroundDefaultImagesDlg::SetVirtualBackgroundDefaultImages()
{
    hwmsdkagent::HwmVirtualBackgroundInfo info{};
    info.type = hwmsdkagent::HwmSettingVrbkDefaultImageMode::HWM_SETTING_VRBK_DEFAULT_IMAGE_MODE_APPEND;
    info.imageList = [{"to/path/image.png"}];
    info.imageLength = 1;
    int ret = hwmsdkagent::SetAnswerType(&info);
    if (hwmsdk::HWM_COMMON_SUCCESS != ret)
    {
        AfxMessageBox(_T("SetVirtualBackgroundDefaultImages error"));
        return;
    }
    CDialogEx::OnOK();
}
父主题： 基础配置

相关文档