Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKVirtualBackgroundHelper.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKVirtualBackgroundHelper.h
3// ZoomVideoSDK
4//
5// Created by Zoom Video Communications on 2022/12/16.
6// Copyright © Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10
18@property (nonatomic, copy, readonly) NSString * _Nullable imageFilePath;
22@property (nonatomic, copy, readonly) NSString * _Nullable imageName;
26@property (nonatomic, assign, readonly) ZoomVideoSDKVirtualBackgroundDataType type;
30@property (nonatomic, assign, readonly) BOOL canVirtualBackgroundBeDeleted;
31
32@end
33
44- (BOOL)isSupportVirtualBackground;
45
51- (ZoomVideoSDKVirtualBackgroundItem * _Nullable)addVirtualBackgroundItem:(UIImage *_Nullable)image;
52
58- (ZoomVideoSDKError)removeVirtualBackgroundItem:(ZoomVideoSDKVirtualBackgroundItem *_Nullable)imageItem;
59
64- (NSArray<ZoomVideoSDKVirtualBackgroundItem * > * _Nullable)getVirtualBackgroundItemList;
65
71- (ZoomVideoSDKError)setVirtualBackgroundItem:(ZoomVideoSDKVirtualBackgroundItem *_Nullable)imageItem;
72
77- (ZoomVideoSDKVirtualBackgroundItem * _Nullable)getSelectedVirtualBackgroundItem;
78
79@end
80
ZoomVideoSDKVirtualBackgroundDataType
Enumerations of the type for virtual background.
ZoomVideoSDKError
ZoomVideoSDKError An enumeration of error.
NSString *_Nullable imageFilePath
Get the current item image file path.
ZoomVideoSDKVirtualBackgroundDataType type
Get the current item background type.
BOOL canVirtualBackgroundBeDeleted
Determine whether the virtual background can be deleted.
NSString *_Nullable imageName
Get the current item image name.