虚拟背景

enableVirtualBackground

开启/关闭虚拟背景。

Objective-C

- (int)enableVirtualBackground:(BOOL)enable backData:(AgoraVirtualBackgroundSource* _Nullable)backData segData:(AgoraSegmentationProperty* _Nullable)segData NS_SWIFT_NAME(enableVirtualBackground(_:backData:segData:));

虚拟背景功能支持将本地用户原来的背景替换为静态图片、动态视频、将背景虚化，或者将人像与背景分割以实现人像画中画。成功开启虚拟背景功能后，频道内所有用户都能看到自定义的背景。

请在 enableVideo 或 startPreview [2/2] 之后调用该方法。

注意：

• 该功能对设备性能要求较高，建议你在搭载如下芯片的设备上使用：

  • CPU 为 i5 及更好的设备

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

  • 使用高清摄像设备、摄像环境光照均匀。

  • 摄像画面中，物件较少，用户的人像为半身人像且基本无遮挡，背景色较单一且与用户着装颜色不同。

• 该方法依赖于虚拟背景动态库 AgoraVideoSegmentationExtension.framework，如果删除该动态库会导致无法正常开启该功能。

参数

参数名	描述
enable	是否开启虚拟背景： YES: 开启虚拟背景。 NO: 关闭虚拟背景。
backData	自定义的背景。详见 AgoraVirtualBackgroundSource。为将自定义背景图的分辨率与 SDK 的视频采集分辨率适配，SDK 会在保证自定义背景图不变形的前提下，对自定义背景图进行缩放和裁剪。
segData	背景图像的处理属性。详见 AgoraSegmentationProperty。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败。

  • -1：自定义的背景图不存在。请检查 AgoraVirtualBackgroundSource 中 source 的值。

  • -2：自定义的背景图颜色格式出错。请检查 AgoraVirtualBackgroundSource 中 color 的值。

  • -3：设备不支持使用虚拟背景。

所属接口类

• AgoraRtcEngineKit