更新时间:2025-10-14 GMT+08:00
分享

设置虚拟背景默认图片

接口功能

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

函数原型

setVirtualBackgroundDefaultImages(defaultImagesInfo: VirtualBackgroundInfo, onSetVirtualBackgroundDefaultImagesResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
defaultImagesInfo Y VirtualBackgroundInfo 虚拟背景信息
onSetVirtualBackgroundDefaultImagesResult Y (ret: SDKERR, reason: string) => void 设置虚拟背景默认图片接口回调
表2 VirtualBackgroundInfo
参数名称 是否必选 参数类型 参数说明
mode Y SettingVrbkDefaultImageMode 设置自定义虚拟背景默认图模式
imageList Y Array<VirtualBackgroundImageInfo> 虚拟背景图列表
表3 SettingVrbkDefaultImageMode枚举说明
枚举名称 枚举值 枚举说明
HWM_SETTING_VRBK_DEFAULT_IMAGE_MODE_REPLACE_ALL 0 全部替换, 覆盖内置的默认图片
HWM_SETTING_VRBK_DEFAULT_IMAGE_MODE_APPEND 1 基于内置的默认图片追加
表4 VirtualBackgroundImageInfo
参数名称 是否必选 参数类型 参数说明
imagePath Y string 虚拟背景图片路径

返回值

void

回调方法参数说明:

(ret: SDKERR, reason: string) => void

表5 入参说明
参数名称 参数类型 参数说明
ret SDKERR 请参考错误码参考 错误码
reason string 错误描述

相关文档