AgoraVirtualBackgroundSource Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Since v3.4.5. 自定义的背景图。

  backgroundSourceType

自定义的背景图类型。详见 AgoraVirtualBackgroundSourceType

@property (nonatomic, assign) AgoraVirtualBackgroundSourceType backgroundSourceType

Declared In

AgoraObjects.h

  color

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

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

@property (nonatomic, assign) NSUInteger color

Declared In

AgoraObjects.h

  source

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

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

@property (nonatomic, copy) NSString *source

Declared In

AgoraObjects.h

  blur_degree

自定义背景图的虚化程度。详见 AgoraBlurDegree

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

@property (nonatomic, assign) AgoraBlurDegree blur_degree

Availability

v3.5.1

Declared In

AgoraObjects.h