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

设置虚拟背景默认图片

setVirtualBackgroundDefaultImages

接口描述

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

注意事项

  1. 该接口非必需调用，若不设置，则使用默认的虚拟背景图片。
  2. 图片格式：jpg/jpeg。
  3. 图片尺寸：最大4096*4096，最小160*160。

方法定义

setVirtualBackgroundDefaultImages(info: HWMVirtualBackgroundDefaultImagesInfo): SDKERR;

参数描述

表1 参数说明

参数

是否必须

类型

描述

mode

是

HWMVirtualBackgroundDefaultImageMode

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

imageList

是

Array<HWMVirtualBackgroundImageInfo>

虚拟背景图列表。
表2 枚举HWMVirtualBackgroundDefaultImageMode说明

枚举值

描述

REPLACE_ALL

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

APPEND

基于内置的默认图片追加。
表3 HWMVirtualBackgroundImageInfo参数说明

参数

是否必须

类型

描述

imagePath

是

string

图片路径。路径是imagePath, 非imageUri，请注意区分。推荐将图片放到应用的沙箱目录下。

返回值

类型

描述

SDKERR

接口调用结果，HWM_SDKERR_SUCCESS表示成功，详细请参考错误码参考。
示例代码 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
/**
*  设置虚拟背景默认图片
*/
handleSetVirtualBackgroundDefaultImages(): void {
    const ret = UISDK.getConfigApi().setVirtualBackgroundDefaultImages({
      mode: HWMVirtualBackgroundDefaultImageMode.APPEND,
      imageList: [
         'to/path/image.jpg', // 图片路径
      ]
    });
}

父主题： 基础配置

相关文档