文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

Electron SDK API Reference

概览 AgoraRtcEngine AgoraRtcEngine.on AgoraRtcChannel AgoraRtcChannel.on 警告码 错误码

自定义的背景图。

Hierarchy

  • VirtualBackgroundSource

Index

Properties

Properties

background_source_type

background_source_type: BACKGROUND_SOURCE_TYPE

自定义的背景图类型。

  • 1: （默认）背景图为纯色。
  • 2: 背景图为 PNG、JPG 格式的图片。
  • 3: 背景图为虚化处理后的背景图。
since

v3.4.5

blur_degree

blur_degree: BACKGROUND_BLUR_DEGREE
since

v3.6.1.4

自定义背景图的虚化程度：

  • 1: 自定义背景图的虚化程度为低。用户差不多能看清背景。
  • 2：自定义背景图的虚化程度为中。用户较难看清背景。
  • 3：（默认）自定义背景图的虚化程度为高。用户很难看清背景。
note

该参数仅在自定义背景图类型为 BACKGROUND_BLUR 时生效。

color

color: number

自定义的背景图颜色。格式为 RGB 定义下的十六进制整数，不要带 # 号，如 0xFFB6C1 表示浅粉色。 默认值为 0xFFFFFF，表示白色。取值范围为 [0x000000,0xffffff]。如果取值非法，SDK 会用白色背景图替换原背景图。

note

该参数仅在自定义背景图类型为 BACKGROUND_COLOR 时生效。

source

source: string

自定义的背景图的本地绝对路径。支持 PNG 和 JPG 格式。如果路径无效，SDK 会用白色背景图替换原背景图。

note

该参数仅在自定义背景图类型为 BACKGROUND_IMG 时生效。