macOS SDK API Reference
Loading...
Searching...
No Matches
<ZoomSDKVirtualBackgroundSettingDelegate> Protocol Reference

#import <ZoomSDKSettingService.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onVBImageDidDownloaded:
 Notify the default virtual background image have been downloaded from web.
 
(void) - onGreenVBDidUpdateWithReplaceColor:
 Notify the virtual background was updated with selected color.
 
(void) - onSelectedVBImageChanged
 Notify the selected virtual background image has been changed, user can get the new selected image through image list.
 
(void) - onVBVideoUploadedResult:failedError:
 Notify the result of adding video virtual background.
 
(void) - onVideoFilterItemThumnailsDownloaded
 Callback event of notification that the thumbnails of all video filter items have been downloaded.
 
(void) - onVideoFilterItemDataDownloading:index:
 Callback event of notification that the selected video filter item is downloading.
 
(void) - onVideoFilterItemDataDownloaded:type:index:
 Callback event of notification that the selected video filter item whether has been downloaded successfully.
 
(void) - onVideoFilterItemDataDownloaded:index:
 Notify the default video fiter item have been downloaded from web.
 
(void) - onVideoFilterItemDataNeedPrepare:index:
 Notify the video fiter item need do some preparing before applied to video.
 
(void) - onVideoFilterItemDataReady:type:index:
 Notify the video fiter item data is ready.
 

Detailed Description

Definition at line 1231 of file ZoomSDKSettingService.h.

Method Documentation

◆ onGreenVBDidUpdateWithReplaceColor:

- (void) onGreenVBDidUpdateWithReplaceColor: (NSColor *)  selectedColor
optional

Notify the virtual background was updated with selected color.

Parameters
selectedColorThe selected color.

◆ onSelectedVBImageChanged

- (void) onSelectedVBImageChanged
optional

Notify the selected virtual background image has been changed, user can get the new selected image through image list.

◆ onVBImageDidDownloaded:

- (void) onVBImageDidDownloaded: (NSString *)  filePath
optional

Notify the default virtual background image have been downloaded from web.

Parameters
filePathThe path of the file.

◆ onVBVideoUploadedResult:failedError:

- (void) onVBVideoUploadedResult: (BOOL)  success
failedError: (ZoomSDKSettingVBVideoError error 
optional

Notify the result of adding video virtual background.

Parameters
successYES means is successfully added, otherwise not.
errorIf failed adding the video virtual background, the error will be notified.

◆ onVideoFilterItemDataDownloaded:index:

- (void) onVideoFilterItemDataDownloaded: (ZoomSDKVideoEffectType type
index: (int)  index 
optional

Notify the default video fiter item have been downloaded from web.

Parameters
typeThe type of the video fiter item.
indexThe index of the video fiter item.

◆ onVideoFilterItemDataDownloaded:type:index:

- (void) onVideoFilterItemDataDownloaded: (BOOL)  ready
type: (ZoomSDKVideoEffectType type
index: (int)  index 
optional

Callback event of notification that the selected video filter item whether has been downloaded successfully.

Parameters
readyYES indicates the selected video filter item has been downloaded successfully.
typetype The type of the selected video filter item.
indexThe index of the selected video filter item.

◆ onVideoFilterItemDataDownloading:index:

- (void) onVideoFilterItemDataDownloading: (ZoomSDKVideoEffectType type
index: (int)  index 
optional

Callback event of notification that the selected video filter item is downloading.

Parameters
typeThe type of the selected video filter item.
indexThe index of the selected video filter item.

◆ onVideoFilterItemDataNeedPrepare:index:

- (void) onVideoFilterItemDataNeedPrepare: (ZoomSDKVideoEffectType type
index: (int)  index 
optional

Notify the video fiter item need do some preparing before applied to video.

◆ onVideoFilterItemDataReady:type:index:

- (void) onVideoFilterItemDataReady: (BOOL)  ready
type: (ZoomSDKVideoEffectType type
index: (int)  index 
optional

Notify the video fiter item data is ready.

Parameters
readyYES means is ready, otherwise not.
typeThe type of the video fiter item.
indexThe index of the video fiter item.

◆ onVideoFilterItemThumnailsDownloaded

- (void) onVideoFilterItemThumnailsDownloaded
optional

Callback event of notification that the thumbnails of all video filter items have been downloaded.