ZoomSDKVirtualBackgroundSetting Class Reference

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKSettingTestVideoDeviceHelper *)	- getSettingVideoTestHelper
	Get the object to video device test helper.
(BOOL)	- isSupportVirtualBG
	Determine if support virtual background feature.
(BOOL)	- isSupportSmartVirtualBG
	Determine if support smart virtual background feature.
(BOOL)	- isUsingGreenScreenOn
	Determine if the using green screen option is enabled.
(ZoomSDKError)	- setUsingGreenScreen:
	Enable or disable the using green screen option.
(ZoomSDKError)	- addBGImage:
	Add virtual background image.
(ZoomSDKError)	- addBGVideo:
	Add virtual background video.
(ZoomSDKError)	- removeBGImage:
	Remove virtual background image.
(ZoomSDKError)	- removeBGVideo:
	Remove virtual background video.
(ZoomSDKError)	- removeBGItem:
	Remove virtual background item.
(NSArray *)	- getBGImageList
	Get the array of virtual background images.
(NSArray *)	- getBGItemList
	Get the array of virtual background video item.
(ZoomSDKError)	- useBGImage:
	Use the specify image as selected virtual background images.
(ZoomSDKError)	- useBGItem:
	Use the specify image as selected virtual background images.
(NSColor *)	- getVBReplaceColor
	Get the selected replace color of virtual background images.
(ZoomSDKError)	- startSelectReplaceVBColor
	Start selected replace color of virtual background images.
(BOOL)	- isSupportSmartVirtualBackgroundVideo
	Determine if support smart virtual background video feature.
(BOOL)	- isSupportGreenVirtualBackgroundVideo
	Determine if support green virtual background video feature.
(BOOL)	- isAllowAddNewVBItem
	Determine if allow add new virtual background item.
(BOOL)	- isAllowRemoveVBItem
	Determine if allow remove virtual background item.
(BOOL)	- isVideoFilterEnabled
	Determine if face makeup feature is enabled.
(BOOL)	- isSupportVideoFilter
	Determine if support face makeup feature.
(NSArray *)	- getVideoFilterItemList
	Get the array of face makeup images.
(ZoomSDKError)	- useVideoFilterItem:index:
	Use the specify image as selected face makeup images.
(ZoomSDKError)	- useVideoFilterItem:
	Use the specify image as selected face makeup images.

Protected Attributes
ZoomSDKSettingTestVideoDeviceHelper *	settingVideoTestHelper
id< ZoomSDKVirtualBackgroundSettingDelegate >	_delegate

Properties
id< ZoomSDKVirtualBackgroundSettingDelegate >	delegate

Detailed Description

Definition at line 1297 of file ZoomSDKSettingService.h.

Method Documentation

addBGImage:

- (ZoomSDKError) addBGImage:

(NSString *)

filePath

Add virtual background image.

Parameters

filePath

The file path of the image user want to add.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

addBGVideo:

- (ZoomSDKError) addBGVideo:

(NSString *)

filePath

Add virtual background video.

Parameters

filePath

The file path of the video user want to add.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

getBGImageList

- (NSArray *) getBGImageList

Get the array of virtual background images.

Returns

If the function succeeds, it will return the NSArray of image list, otherwise nil.

getBGItemList

- (NSArray *) getBGItemList

Get the array of virtual background video item.

Returns

If the function succeeds, it will return the NSArray of video item list, otherwise nil.

getSettingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper *) getSettingVideoTestHelper

Get the object to video device test helper.

Returns

If the function succeeds, it will return a ZoomSDKSettingTestVideoDeviceHelper object, otherwise failed, returns nil.

getVBReplaceColor

- (NSColor *) getVBReplaceColor

Get the selected replace color of virtual background images.

Returns

If the function succeeds, it will return the color, otherwise nil.

getVideoFilterItemList

- (NSArray *) getVideoFilterItemList

Get the array of face makeup images.

Returns

If the function succeeds, it will return the NSArray of image list, otherwise nil.

isAllowAddNewVBItem

- (BOOL) isAllowAddNewVBItem

Determine if allow add new virtual background item.

Returns

YES means is allowed, otherwise not.

isAllowRemoveVBItem

- (BOOL) isAllowRemoveVBItem

Determine if allow remove virtual background item.

Returns

YES means is allowed remove, otherwise not.

isSupportGreenVirtualBackgroundVideo

- (BOOL) isSupportGreenVirtualBackgroundVideo

Determine if support green virtual background video feature.

Returns

YES means is support, otherwise not.

isSupportSmartVirtualBackgroundVideo

- (BOOL) isSupportSmartVirtualBackgroundVideo

Determine if support smart virtual background video feature.

Returns

YES means is support, otherwise not.

isSupportSmartVirtualBG

- (BOOL) isSupportSmartVirtualBG

Determine if support smart virtual background feature.

Returns

YES means is support, otherwise not.

isSupportVideoFilter

- (BOOL) isSupportVideoFilter

Determine if support face makeup feature.

Returns

YES means is support, otherwise not.

isSupportVirtualBG

- (BOOL) isSupportVirtualBG

Determine if support virtual background feature.

Returns

YES means is support, otherwise not.

isUsingGreenScreenOn

- (BOOL) isUsingGreenScreenOn

Determine if the using green screen option is enabled.

Returns

YES means is enabled, otherwise not.

isVideoFilterEnabled

- (BOOL) isVideoFilterEnabled

Determine if face makeup feature is enabled.

Returns

YES means is enabled, otherwise not.

removeBGImage:

- (ZoomSDKError) removeBGImage:

(NSString *)

filePath

Remove virtual background image.

Parameters

filePath

The path of the virtualbackground image item user want to remove.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

removeBGItem:

- (ZoomSDKError) removeBGItem:

(ZoomSDKVirtualBGImageInfo *)

virtualBGImageInfo

Remove virtual background item.

Parameters

virtualBGImageInfo

The ZoomSDKVirtualBGImageInfo object user want to remove.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

removeBGVideo:

- (ZoomSDKError) removeBGVideo:

(NSString *)

filePath

Remove virtual background video.

Parameters

filePath

The path of the virtualbackground video item user want to remove.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

setUsingGreenScreen:

- (ZoomSDKError) setUsingGreenScreen:

(BOOL)

bUse

Enable or disable the using green screen option.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

startSelectReplaceVBColor

- (ZoomSDKError) startSelectReplaceVBColor

Start selected replace color of virtual background images.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise nil.

Note

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

useBGImage:

- (ZoomSDKError) useBGImage:

(NSString *)

filePath

Use the specify image as selected virtual background images.

Parameters

filePath

The path of the virtualbackground image or video item user want to select.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

useBGItem:

- (ZoomSDKError) useBGItem:

(ZoomSDKVirtualBGImageInfo *)

item

Use the specify image as selected virtual background images.

Parameters

item	The path of the virtualbackground image or video item user want to select.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

useVideoFilterItem:

- (ZoomSDKError) useVideoFilterItem:

(ZoomSDKVideoFilterItemInfo *)

imageInfo

Use the specify image as selected face makeup images.

Parameters

imageInfo

It is video filter object.More detail refer to ZoomSDKVideoFilterItemInfo

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

useVideoFilterItem:index:

- (ZoomSDKError) useVideoFilterItem:		(ZoomSDKVideoEffectType)	type
index:		(int)	index

Use the specify image as selected face makeup images.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

Field Documentation

_delegate

- (id<ZoomSDKVirtualBackgroundSettingDelegate>) _delegate

protected

Definition at line 1300 of file ZoomSDKSettingService.h.

settingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper*) settingVideoTestHelper

protected

Definition at line 1299 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKVirtualBackgroundSettingDelegate>) delegate

readwritenonatomicassign

Definition at line 1302 of file ZoomSDKSettingService.h.