ZoomSDKVirtualBackgroundSetting Class Reference

Interface for configuring virtual background and video filter settings. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKSettingTestVideoDeviceHelper *_Nullable)	- getSettingVideoTestHelper
	Gets the object to video device test helper.
(BOOL)	- isSupportVirtualBG
	Determines if support virtual background feature.
(BOOL)	- isSupportVirtualBackgroundVideo
	Determines if meeting supports the video virtual video background feature.
(BOOL)	- isDeviceSupportSmartVirtualBG
	Determines if the machine can support the smart virtual background feature.
(BOOL)	- isUsingGreenScreenOn
	Determines if the using green screen option is enabled.
(ZoomSDKError)	- setUsingGreenScreen:
	Enables or disable the using green screen option.
(ZoomSDKError)	- addBGImage:
	Adds virtual background image.
(ZoomSDKError)	- addBGVideo:
	Adds virtual background video.
(ZoomSDKError)	- removeBGItem:
	Removes virtual background item.
(NSArray *_Nullable)	- getBGItemList
	Gets the array of virtual background video item.
(ZoomSDKError)	- useBGItem:
	Use the specify image as selected virtual background images.
(NSColor *_Nullable)	- getVBReplaceColor
	Gets the selected replace color of virtual background images.
(ZoomSDKError)	- startSelectReplaceVBColor
	Starts selected replace color of virtual background images.
(BOOL)	- isDeviceSupportSmartVirtualBackgroundVideo
	Determines if the machine can support the smart virtual background video feature.
(BOOL)	- isDeviceSupportGreenVirtualBackgroundVideo
	Determines if the machine can support the green virtual background video feature.
(BOOL)	- isAllowAddNewVBItem
	Determines if the meeting supports the adding a new virtual background item feature.
(BOOL)	- isAllowRemoveVBItem
	Determines if the meeting supports the removing a new virtual background item feature.
(BOOL)	- isVideoFilterEnabled
	Determines if face makeup feature is enabled.
(BOOL)	- isSupportVideoFilter
	Determines if support face makeup feature.
(NSArray *_Nullable)	- getVideoFilterItemList
	Gets the array of face makeup images.
(ZoomSDKError)	- useVideoFilterItem:
	Use the specify image as selected face makeup images.

Protected Attributes
id< ZoomSDKVirtualBackgroundSettingDelegate >	_delegate

Properties
id< ZoomSDKVirtualBackgroundSettingDelegate >	delegate

Detailed Description

Interface for configuring virtual background and video filter settings.

Definition at line 1748 of file ZoomSDKSettingService.h.

Method Documentation

addBGImage:

- (ZoomSDKError) addBGImage:

(NSString *)

filePath

Adds virtual background image.

Parameters

filePath

The image's file path user want to add.

Returns

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

addBGVideo:

- (ZoomSDKError) addBGVideo:

(NSString *)

filePath

Adds virtual background video.

Parameters

filePath

The video's file path user want to add.

Returns

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

getBGItemList

- (NSArray *_Nullable) getBGItemList

Gets the array of virtual background video item.

Returns

If the function succeeds, it returns the NSArray of video item list. Otherwise, this function fails and returns nil.

getSettingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getSettingVideoTestHelper

Gets the object to video device test helper.

Returns

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

getVBReplaceColor

- (NSColor *_Nullable) getVBReplaceColor

Gets the selected replace color of virtual background images.

Returns

If the function succeeds, it returns the color. Otherwise, this function fails and returns nil.

getVideoFilterItemList

- (NSArray *_Nullable) getVideoFilterItemList

Gets the array of face makeup images.

Returns

If the function succeeds, it returns the NSArray of image list. Otherwise, this function fails and returns nil.

isAllowAddNewVBItem

- (BOOL) isAllowAddNewVBItem

Determines if the meeting supports the adding a new virtual background item feature.

Returns

YES if is allowed. Otherwise, NO.

isAllowRemoveVBItem

- (BOOL) isAllowRemoveVBItem

Determines if the meeting supports the removing a new virtual background item feature.

Returns

YES if is allowed remove. Otherwise, NO.

isDeviceSupportGreenVirtualBackgroundVideo

- (BOOL) isDeviceSupportGreenVirtualBackgroundVideo

Determines if the machine can support the green virtual background video feature.

Returns

YES if is support. Otherwise, NO.

isDeviceSupportSmartVirtualBackgroundVideo

- (BOOL) isDeviceSupportSmartVirtualBackgroundVideo

Determines if the machine can support the smart virtual background video feature.

Returns

YES if is support. Otherwise, NO.

isDeviceSupportSmartVirtualBG

- (BOOL) isDeviceSupportSmartVirtualBG

Determines if the machine can support the smart virtual background feature.

Returns

YES if is support. Otherwise, NO.

isSupportVideoFilter

- (BOOL) isSupportVideoFilter

Determines if support face makeup feature.

Returns

YES if is support. Otherwise, NO.

isSupportVirtualBackgroundVideo

- (BOOL) isSupportVirtualBackgroundVideo

Determines if meeting supports the video virtual video background feature.

Returns

YES if is support. Otherwise, NO.

isSupportVirtualBG

- (BOOL) isSupportVirtualBG

Determines if support virtual background feature.

Returns

YES if is support. Otherwise, NO.

isUsingGreenScreenOn

- (BOOL) isUsingGreenScreenOn

Determines if the using green screen option is enabled.

Returns

YES if is enabled. Otherwise, NO.

isVideoFilterEnabled

- (BOOL) isVideoFilterEnabled

Determines if face makeup feature is enabled.

Returns

YES if is enabled. Otherwise, NO.

removeBGItem:

- (ZoomSDKError) removeBGItem:

(ZoomSDKVirtualBGImageInfo *)

virtualBGImageInfo

Removes virtual background item.

Parameters

virtualBGImageInfo

The ZoomSDKVirtualBGImageInfo object user want to remove.

Returns

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

setUsingGreenScreen:

- (ZoomSDKError) setUsingGreenScreen:

(BOOL)

bUse

Enables or disable the using green screen option.

Returns

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

startSelectReplaceVBColor

- (ZoomSDKError) startSelectReplaceVBColor

Starts selected replace color of virtual background images.

Returns

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

Note

The selected replace color will be notified from callback event '- (void)onSelectedVBImageChanged'.

useBGItem:

- (ZoomSDKError) useBGItem:

(ZoomSDKVirtualBGImageInfo *)

item

Use the specify image as selected virtual background images.

Parameters

item	The virtualbackground image or video item's path user want to select.

Returns

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

useVideoFilterItem:

- (ZoomSDKError) useVideoFilterItem:

(ZoomSDKVideoFilterItemInfo *)

imageInfo

Use the specify image as selected face makeup images.

Parameters

imageInfo

It is video filter object.

Returns

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

Field Documentation

_delegate

- (id<ZoomSDKVirtualBackgroundSettingDelegate>) _delegate

protected

Definition at line 1750 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKVirtualBackgroundSettingDelegate>) delegate

readwritenonatomicassign

Definition at line 1752 of file ZoomSDKSettingService.h.