Agora RTC Objective-C API Reference  Refactor
Properties
AgoraVirtualBackgroundSource Class Reference

Inherits <NSObject>.

Properties

AgoraVirtualBackgroundSourceType backgroundSourceType
 
NSUInteger color
 
NSString *_Nullable source
 
AgoraBlurDegree blurDegree
 

Detailed Description

The custom background image.

Property Documentation

◆ backgroundSourceType

- (AgoraVirtualBackgroundSourceType) backgroundSourceType
readwritenonatomicassign

The type of the custom background image. See AgoraVirtualBackgroundSourceType.

◆ color

- (NSUInteger) color
readwritenonatomicassign

The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000,0xFFFFFF]. If the value is invalid, the SDK replaces the original background image with a white background image.

Note: This parameter takes effect only when the type of the custom background image is AgoraVirtualBackgroundColor.

◆ source

- (NSString* _Nullable) source
readwritenonatomiccopy

The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image.

Note: This parameter takes effect only when the type of the custom background image is AgoraVirtualBackgroundImg.

◆ blurDegree

- (AgoraBlurDegree) blurDegree
readwritenonatomicassign

Background blur degree, for example: 1 2 3