Video SDK for iOS API Reference
Loading...
Searching...
No Matches
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
19@property (nonatomic, copy, readonly) NSString * _Nullable imageFilePath;
23@property (nonatomic, copy, readonly) NSString * _Nullable imageName;
27@property (nonatomic, assign, readonly) ZoomVideoSDKVirtualBackgroundDataType type;
31@property (nonatomic, assign, readonly) BOOL canVirtualBackgroundBeDeleted;
32
33@end
34
45- (BOOL)isSupportVirtualBackground;
46
52- (ZoomVideoSDKVirtualBackgroundItem * _Nullable)addVirtualBackgroundItem:(UIImage *_Nullable)image;
53
59- (ZoomVideoSDKError)removeVirtualBackgroundItem:(ZoomVideoSDKVirtualBackgroundItem *_Nullable)imageItem;
60
65- (NSArray<ZoomVideoSDKVirtualBackgroundItem * > * _Nullable)getVirtualBackgroundItemList;
66
72- (ZoomVideoSDKError)setVirtualBackgroundItem:(ZoomVideoSDKVirtualBackgroundItem *_Nullable)imageItem;
73
78- (ZoomVideoSDKVirtualBackgroundItem * _Nullable)getSelectedVirtualBackgroundItem;
79
80@end
81
ZoomVideoSDKVirtualBackgroundDataType
Enumerates the types of virtual backgrounds.
ZoomVideoSDKError
Enumerates all errors in the VideoSDK.
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.