enableVirtualBackground method Null safety

Future<void> enableVirtualBackground(
  1. bool enabled,
  2. VirtualBackgroundSource backgroundSource
)

开启/关闭虚拟背景。(beta 功能)

Parameter enabled 设置是否开启虚拟背景:

  • true: 开启。
  • false: 关闭。

Parameter backgroundSource 自定义的背景图。详见 VirtualBackgroundSource。

Note

为将自定义背景图的分辨率与 SDK 的视频采集分辨率适配,SDK 会在保证自定义背景图内容不变形的前提下,对自定义背景图进行缩放和裁剪。

Note

  • 请在 enableVideo 后调用该方法。

Agora 建议你在满足如下条件的场景中使用该功能:

  • 使用高清摄像设备、摄像环境光照均匀。
  • 摄像画面中,物件较少,用户的人像为半身人像且基本无遮挡,背景色较单一且与用户着装颜色不同。

该功能对设备性能要求较高,Agora 推荐你在搭载如下芯片的设备上使用:

搭载 A9 及以上芯片的 iOS 设备:

  • iPhone 6S 及以上
  • iPad Air 第三代及以上
  • iPad 第五代及以上
  • iPad Pro 第一代及以上
  • iPad mini 第五代及以上

搭载如下芯片的 Android 设备:

  • 骁龙 700 系列 750G 及以上
  • 骁龙 800 系列 835 及以上
  • 天玑 700 系列 720 及以上
  • 麒麟 800 系列 810 及以上
  • 麒麟 900 系列 980 及以上

Implementation

@override
Future<void> enableVirtualBackground(
    bool enabled, VirtualBackgroundSource backgroundSource) {
  return _invokeMethod('enableVirtualBackground', {
    'enabled': enabled,
    'backgroundSource': backgroundSource.toJson(),
  });
}