ZoomVideoSDKVirtualBackgroundHelper Class Reference

Virtual background helper. More...

#include <ZoomVideoSDKVirtualBackgroundHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportVirtualBackground
	Determine whether the user can support smart virtual backgrounds.
(ZoomVideoSDKVirtualBackgroundItem *_Nullable)	- addVirtualBackgroundItem:
	Add virtual background object.
(ZoomVideoSDKError)	- removeVirtualBackgroundItem:
	Remove virtual background object.
(NSArray< ZoomVideoSDKVirtualBackgroundItem * > *_Nullable)	- getVirtualBackgroundItemList
	Returns a collection of virtual background item as an object.
(ZoomVideoSDKError)	- setVirtualBackgroundItem:
	Select virtual background item.
(ZoomVideoSDKVirtualBackgroundItem *_Nullable)	- getSelectedVirtualBackgroundItem
	Get a 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

Add virtual background object.

Parameters

image

image of virtual background.

Returns

An object of type ZoomVideoSDKVirtualBackgroundItem. Once the function is called successfully, this parameter will store the pointer to the ZoomVideoSDKVirtualBackgroundItem*.

getSelectedVirtualBackgroundItem

- (ZoomVideoSDKVirtualBackgroundItem *_Nullable) getSelectedVirtualBackgroundItem

Get a selected virtual background item.

Returns

If the function succeeds, it will return the object.

getVirtualBackgroundItemList

- (NSArray< ZoomVideoSDKVirtualBackgroundItem * > *_Nullable) getVirtualBackgroundItemList

Returns a collection of virtual background item as an object.

Returns

If the function succeeds, it will return a list of virtual background items.

isSupportVirtualBackground

- (BOOL) isSupportVirtualBackground

Determine whether the user can support smart virtual backgrounds.

Returns

YES means the user can support it and you can use it.

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 be embed zoomcml.xcframework.

removeVirtualBackgroundItem:

- (ZoomVideoSDKError) removeVirtualBackgroundItem:

(ZoomVideoSDKVirtualBackgroundItem *_Nullable)

imageItem

Remove virtual background object.

Parameters

imageItem

The ZoomVideoSDKVirtualBackgroundItem object to be removed.

Returns

If the function succeeds, it will return Errors_Success.

setVirtualBackgroundItem:

- (ZoomVideoSDKError) setVirtualBackgroundItem:

(ZoomVideoSDKVirtualBackgroundItem *_Nullable)

imageItem

Select virtual background item.

Parameters

imageItem

The ZoomVideoSDKVirtualBackgroundItem object to select.

Returns

If the function succeeds, it will return Errors_Success.