◆ 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.
◆ getSettingVideoTestHelper
◆ 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.
◆ 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.
◆ 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.
The documentation for this class was generated from the following file: