ZoomVideoSDKVirtualBackgroundHelper Class Reference

Virtual background helper. More...

#include <ZoomVideoSDKVirtualBackgroundHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportVirtualBackground
	Determines whether the user can support smart virtual backgrounds.
(ZoomVideoSDKVirtualBackgroundItem *_Nullable)	- addVirtualBackgroundItem:
	Adds a virtual background object.
(ZoomVideoSDKError)	- removeVirtualBackgroundItem:
	Removes a virtual background object.
(NSArray< ZoomVideoSDKVirtualBackgroundItem * > *_Nullable)	- getVirtualBackgroundItemList
	Gets a collection of virtual background items.
(ZoomVideoSDKError)	- setVirtualBackgroundItem:
	Selects a virtual background item.
(ZoomVideoSDKVirtualBackgroundItem *_Nullable)	- getSelectedVirtualBackgroundItem
	Gets the selected virtual background item.

Detailed Description

Virtual background helper.

Definition at line 36 of file ZoomVideoSDKVirtualBackgroundHelper.h.

Method Documentation

addVirtualBackgroundItem:

- (ZoomVideoSDKVirtualBackgroundItem *_Nullable) addVirtualBackgroundItem:

(UIImage *_Nullable)

image

Adds a virtual background object.

Parameters

image

The image of virtual background.

Returns

If the function succeeds, it returns a ZoomVideoSDKVirtualBackgroundItem object. Otherwise, this function fails and returns nil.

getSelectedVirtualBackgroundItem

- (ZoomVideoSDKVirtualBackgroundItem *_Nullable) getSelectedVirtualBackgroundItem

Gets the selected virtual background item.

Returns

If the function succeeds, it returns a ZoomVideoSDKVirtualBackgroundItem object. Otherwise, this function fails and returns nil.

getVirtualBackgroundItemList

- (NSArray< ZoomVideoSDKVirtualBackgroundItem * > *_Nullable) getVirtualBackgroundItemList

Gets a collection of virtual background items.

Returns

If the function succeeds, it returns an NSArray of ZoomVideoSDKVirtualBackgroundItem objects. Otherwise, this function fails and returns nil.

isSupportVirtualBackground

- (BOOL) isSupportVirtualBackground

Determines whether the user can support smart virtual backgrounds.

Returns

YES if the user can support it and you can use it. Otherwise, NO.

Warning

Device should be iPhone 8, 8 Plus, X or above or be iPad Pro 9.7 above, OS should be iOS 11 or above. And should embed zoomcml.xcframework.

removeVirtualBackgroundItem:

- (ZoomVideoSDKError) removeVirtualBackgroundItem:

(ZoomVideoSDKVirtualBackgroundItem *_Nullable)

imageItem

Removes a virtual background object.

Parameters

imageItem

The ZoomVideoSDKVirtualBackgroundItem object to be removed.

Returns

If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

setVirtualBackgroundItem:

- (ZoomVideoSDKError) setVirtualBackgroundItem:

(ZoomVideoSDKVirtualBackgroundItem *_Nullable)

imageItem

Selects a virtual background item.

Parameters

imageItem

The ZoomVideoSDKVirtualBackgroundItem object to select.

Returns

If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.