AgoraVirtualBackgroundSourceStateReason Constants Reference

Declared in AgoraEnumerates.h
Availability v3.4.5

AgoraVirtualBackgroundSourceStateReason

The reason why the virtual background is not successfully enabled or the message that confirms success.

Definition

typedef NS_ENUM(NSUInteger, AgoraVirtualBackgroundSourceStateReason ) {
   AgoraVBSStateReasonSuccess = 0,
   AgoraVBSStateReasonImageNotExist = 1,
   AgoraVBSStateReasonColorFormatNotSupported = 2,
   AgoraVBSStateReasonDeviceNotSupported = 3,
};

Constants

AgoraVBSStateReasonSuccess

0: The virtual background is successfully enabled.

Declared In AgoraEnumerates.h.

AgoraVBSStateReasonImageNotExist

1: The custom background image does not exist. Please check the value of source in AgoraVirtualBackgroundSource.

Declared In AgoraEnumerates.h.

AgoraVBSStateReasonColorFormatNotSupported

2: The color format of the custom background image is invalid. Please check the value of color in AgoraVirtualBackgroundSource.

Declared In AgoraEnumerates.h.

AgoraVBSStateReasonDeviceNotSupported

3: The device does not support using the virtual background.

Declared In AgoraEnumerates.h.

Availability

v3.4.5

Declared In

AgoraEnumerates.h