AgoraVirtualBackgroundSource Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Since v3.4.5. The custom background image.

  backgroundSourceType

The type of the custom background image. See AgoraVirtualBackgroundSourceType.

@property (nonatomic, assign) AgoraVirtualBackgroundSourceType backgroundSourceType

Declared In

AgoraObjects.h

  color

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.

@property (nonatomic, assign) NSUInteger color

Declared In

AgoraObjects.h

  source

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.

@property (nonatomic, copy) NSString *source

Declared In

AgoraObjects.h