Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKVirtualBGImageInfo Class Reference

Information of a virtual background image or video item. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSelected
 Determines if it is the selected virtual background image.
(NSString *_Nullable) - getImageFilePath
 Gets file path of the virtual background image.
(NSString *_Nullable) - getImageName
 Gets image file name of the virtual background image.
(BOOL) - isVideo
 Determines if the selected virtual background is video.
(BOOL) - isAllowDelete
 Determines if the virtual background item can be deleted.

Detailed Description

Information of a virtual background image or video item.

Definition at line 1590 of file ZoomSDKSettingService.h.

Method Documentation

◆ getImageFilePath

- (NSString *_Nullable) getImageFilePath

Gets file path of the virtual background image.

Returns
If the function succeeds, it returns the image file path. Otherwise, this function fails and returns nil.

References getImageFilePath.

Referenced by getImageFilePath.

◆ getImageName

- (NSString *_Nullable) getImageName

Gets image file name of the virtual background image.

Returns
If the function succeeds, it returns the image file name. Otherwise, this function fails and returns nil.

References getImageName.

Referenced by getImageName.

◆ isAllowDelete

- (BOOL) isAllowDelete

Determines if the virtual background item can be deleted.

Returns
YES if is the selected virtual background can be deleted. Otherwise, NO.

References isAllowDelete.

Referenced by isAllowDelete.

◆ isSelected

- (BOOL) isSelected

Determines if it is the selected virtual background image.

Returns
YES if is the selected virtual background image. Otherwise, NO.

References isSelected.

Referenced by isSelected.

◆ isVideo

- (BOOL) isVideo

Determines if the selected virtual background is video.

Returns
YES if is the selected virtual background is video. Otherwise, NO.

References isVideo.

Referenced by isVideo.