虚拟背景
enableVirtualBackground:backData:segData:
开启/关闭虚拟背景。
Objective-C
- (int)enableVirtualBackground:(BOOL)enable backData:(AgoraVirtualBackgroundSource* _Nullable)backData segData:(AgoraSegmentationProperty* _Nullable)segData NS_SWIFT_NAME(enableVirtualBackground(_:backData:segData:));
详情
虚拟背景功能支持将本地用户原来的背景替换为静态图片、动态视频、将背景虚化,或者将人像与背景分割以实现人像画中画。成功开启虚拟背景功能后,频道内所有用户都能看到自定义的背景。
请在 enableVideo 或 startPreview: 之后调用该方法。
注意
- 该功能对设备性能要求较高,调用该方法时 SDK 会自动对当前设备能力进行检查。建议你在搭载如下芯片的设备上使用:
- CPU 为 i5 及更好的设备
- 建议你在满足如下条件的场景中使用该功能:
- 使用高清摄像设备、摄像环境光照均匀。
- 摄像画面中,物件较少,用户的人像为半身人像且基本无遮挡,背景色较单一且与用户着装颜色不同。
- 该方法依赖于虚拟背景动态库
AgoraVideoSegmentationExtension.framework
,如果删除该动态库会导致无法正常开启该功能。
参数
- enable
- 是否开启虚拟背景:
YES
: 开启虚拟背景。NO
: 关闭虚拟背景。
- backData
- 自定义的背景。详见 AgoraVirtualBackgroundSource。为将自定义背景图的分辨率与 SDK 的视频采集分辨率适配,SDK 会在保证自定义背景图不变形的前提下,对自定义背景图进行缩放和裁剪。
- segData
- 背景图像的处理属性。详见 AgoraSegmentationProperty。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -4:设备能力不满足虚拟背景的使用要求,建议更换性能更高的设备。
enableVirtualBackground:backData:segData:sourceType:
开启虚拟背景并指定媒体源,或关闭虚拟背景。
Objective-C
- (int)enableVirtualBackground:(BOOL)enable backData:(AgoraVirtualBackgroundSource* _Nullable)backData segData:(AgoraSegmentationProperty* _Nullable)segData sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(enableVirtualBackground(_:backData:segData:sourceType:));
详情
虚拟背景功能支持将本地用户原来的背景替换为静态图片、动态视频、将背景虚化,或者将人像与背景分割以实现人像画中画。成功开启虚拟背景功能后,频道内所有用户都能看到自定义的背景。
该方法和 enableVirtualBackground:backData:segData: 均可用于开启/关闭虚拟背景,区别在于该方法支持在开启虚拟背景时指定应用虚拟背景的媒体源。
请在 enableVideo 或 startPreview: 之后调用该方法。
注意
- 该功能对设备性能要求较高,调用该方法时 SDK 会自动对当前设备能力进行检查。建议你在搭载如下芯片的设备上使用:
- CPU 为 i5 及更好的设备
- 建议你在满足如下条件的场景中使用该功能:
- 使用高清摄像设备、摄像环境光照均匀。
- 摄像画面中,物件较少,用户的人像为半身人像且基本无遮挡,背景色较单一且与用户着装颜色不同。
- 该方法依赖于虚拟背景动态库
AgoraVideoSegmentationExtension.framework
,如果删除该动态库会导致无法正常开启该功能。
参数
- enable
- 是否开启虚拟背景:
YES
: 开启虚拟背景。NO
: 关闭虚拟背景。
- backData
- 自定义的背景。详见 AgoraVirtualBackgroundSource。为将自定义背景图的分辨率与 SDK 的视频采集分辨率适配,SDK 会在保证自定义背景图不变形的前提下,对自定义背景图进行缩放和裁剪。
- segData
- 背景图像的处理属性。详见 AgoraSegmentationProperty。
- sourceType
- 效果应用的媒体源类型。详见 AgoraMediaSourceType。注意在该方法中,该参数仅支持以下两种设置:
- 默认值为 AgoraMediaSourceTypePrimaryCamera。
- 如果要使用自定义采集的视频,将该参数设置为 AgoraMediaSourceTypeCustomVideo。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -4:设备能力不满足虚拟背景的使用要求,建议更换性能更高的设备。