配置虚拟背景

最近更新时间:2024-11-26 16:04:13

我的收藏

接口描述

接口名:ui.setVirtualBackground
描述:配置虚拟背景的相关属性。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本:3.9.0及以上版本。
是否需要鉴权:是,需要虚拟背景设置权限。

输入参数

参数名称
参数类型
参数描述
contentType
String
虚拟背景的内容类型。
image/png-png 格式
image/jpeg-jpg 格式
image/bmp-bmp 格式
video/mp4 -mp4 格式
video/quicktime-mov 格式
url
String
背景下载地址。
md5
String
图片或者视频的 md5 值。
progressCallback
Code:Number,Message:String
progress:当前虚拟背景配置进度。
successCallback
Code:Number,Message:String
成功回调。
failedCallback
Code:Number,Message:String
虚拟背景设置失败的类型。
1:kVBKErrorParam
2:kVBKErrorFileWidthOrHeightTooLarge
3:kVBKErrorFileWidthOrHeightTooSmall
4:kVBKErrorFileDecodeFailed
5:kVBKErrorFileSizeTooBig
6:kVBKErrorIsBusying

代码示例

wemeet.ui.setVirtualBackground({
contentType: MatterContentType.BMP,
url: 'https://www.baidu',
progress: ({ progress }) => {

},
success: () => {

},
fail: ({ code, message }) => {

},
md5: 'sdfasdfadsf213213',
}).catch(e => console.error(e));