VirtualBackgroundSource class
The custom background image.
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
- VirtualBackgroundSource({VirtualBackgroundSourceType? backgroundSourceType, int? color, String? source, VirtualBackgroundBlurDegree blurDegree = VirtualBackgroundBlurDegree.High})
- Constructs the VirtualBackgroundSource.
Properties
- backgroundSourceType ↔ VirtualBackgroundSourceType?
-
The type of the custom background image. See BACKGROUND_SOURCE_TYPE .
getter/setter pair
- blurDegree ↔ VirtualBackgroundBlurDegree
-
The degree of blurring applied to the custom background image. See VirtualBackgroundBlurDegree .
This parameter takes effect only when the type of the custom background image is BACKGROUND_BLUR.
getter/setter pair
- color ↔ int?
-
The type of the custom background image. 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. This parameter takes effect only when the type of the custom background image is BACKGROUND_COLOR.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- source ↔ String?
-
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. This parameter takes effect only when the type of the custom background image is BACKGROUND_IMG.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited