Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKShareHelper.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <ZoomVideoSDK/ZoomVideoSDKAnnotationHelper.h>
8
9@protocol ZoomVideoSDKShareSource;
10@protocol ZoomVideoSDKShareAudioSource;
11@protocol ZoomVideoSDKSharePreprocessor;
16@interface ZoomVideoSDKShareStatus : NSObject
20@property (nonatomic, assign) ZoomVideoSDKReceiveSharingStatus sharingStatus;
21
22@end
23
26
31@interface ZoomVideoSDKShareAction : NSObject
36- (NSInteger)getShareSourceId;
41- (ZoomVideoSDKVideoCanvas *_Nullable)getShareCanvas;
46- (ZoomVideoSDKReceiveSharingStatus )getShareStatus;
51- (ZoomVideoSDKRawDataPipe *_Nullable)getSharePipe;
56- (ZoomVideoSDKSubscribeFailReason)getSubscribeFailReason;
61- (BOOL)isAnnotationPrivilegeEnabled;
66- (ZoomVideoSDKShareType)getShareType;
71- (CGSize)getShareSourceContentSize;
72
73@end
74
83@property (nonatomic, assign) ZoomVideoSDKSharePreprocessType type;
87@property (nonatomic, weak) UIView *view;
88@end
89
95
101- (ZoomVideoSDKError)sendPreprocessedData:(ZoomVideoSDKVideoRawData * _Nullable)rawData;
102
103@end
104
105
106
111@interface ZoomVideoSDKShareHelper : NSObject
112
120- (ZoomVideoSDKError)startShareWithView:(UIView * _Nullable)view;
121
130- (ZoomVideoSDKError)startSharingExternalSource:(id<ZoomVideoSDKShareSource> _Nullable)shareDelegate andAudioSource:(id <ZoomVideoSDKShareAudioSource> _Nullable)audioDelegate DEPRECATED_MSG_ATTRIBUTE("use startSharingExternalSource:andAudioSource:isPlaying: instead");
131
140- (ZoomVideoSDKError)startSharingExternalSource:(id<ZoomVideoSDKShareSource> _Nullable)shareDelegate andAudioSource:(id <ZoomVideoSDKShareAudioSource> _Nullable)audioDelegate isPlaying:(BOOL)isPlaying;
141
147- (ZoomVideoSDKError)enablePlaySharingAudioRawdata:(BOOL)bPlay;
148
153- (ZoomVideoSDKError)stopShare;
154
159- (ZoomVideoSDKError)pauseShare;
160
165- (ZoomVideoSDKError)resumeShare;
166
173- (ZoomVideoSDKError)lockShare:(BOOL)lock;
174
179- (BOOL)isShareLocked;
180
185- (BOOL)isSharingOut;
186
191- (BOOL)isOtherSharing;
192
197- (BOOL)isScreenSharingOut;
198
203- (BOOL)isShareDeviceAudioEnabled;
204
210- (BOOL)enableShareDeviceAudio:(BOOL)enable;
211
216- (BOOL)isAnnotationFeatureSupport;
217
224- (ZoomVideoSDKError)disableViewerAnnotation:(BOOL)disable;
225
231- (BOOL)isViewerAnnotationDisabled;
232
239- (ZoomVideoSDKAnnotationHelper * _Nullable)createAnnotationHelper:(UIView * _Nullable)view;
240
246- (ZoomVideoSDKError)destroyAnnotationHelper:(ZoomVideoSDKAnnotationHelper * _Nullable)helper;
247
255- (ZoomVideoSDKError)setAnnotationVanishingToolTime:(NSUInteger)displayTime vanishingTime:(NSUInteger)vanishingTime;
256
262- (NSUInteger)getAnnotationVanishingToolDisplayTime;
263
269- (NSUInteger)getAnnotationVanishingToolVanishingTime;
270
271#pragma mark - multi share -
278- (ZoomVideoSDKError)enableMultiShare:(BOOL)enable;
279
284- (BOOL)isMultiShareEnabled;
285
286#pragma mark - share camera and anno -
293- (ZoomVideoSDKError)startShareCamera:(UIView *_Nullable)parentView API_UNAVAILABLE(visionos);
294
295#pragma mark - share with pre-process -
304- (ZoomVideoSDKError)startShareWithPreprocessing:(ZoomVideoSDKSharePreprocessParam * _Nullable)param sharePreprocessor:(id<ZoomVideoSDKSharePreprocessor> _Nullable)preProcessDelegate;
305
311- (ZoomVideoSDKError)applyPreprocessingOverlayImage:(UIImage *_Nullable)image;
312
317- (void)removePreprocessingOverlayImage;
318
319#pragma mark - in-app screen share -
320
325- (BOOL)isSupportInAppScreenShare;
326
332- (ZoomVideoSDKError)startInAppScreenShare;
333
340- (ZoomVideoSDKError)setAnnotationView:(UIView *_Nullable)annoParentView;
341
342@end
343
344
ZoomVideoSDKSubscribeFailReason
Enumeration of video subscription failure reasons.
ZoomVideoSDKSharePreprocessType
Enumeration of share preprocess types.
ZoomVideoSDKReceiveSharingStatus
Enumeration of the sharing status.
ZoomVideoSDKShareType
Enumeration of content types that can be shared in a session.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
Annotation helper interface for Zoom Video SDK.
A class to manage the subscription and unsubscription of video or share raw data.
Share raw data pipe interface.
Share control interface.
Start pre-process share's parameter.
Start pre-process share's sender interface.
ZoomVideoSDKReceiveSharingStatus sharingStatus
The user's share status.
The video canvas is the display area of the video streams on the user’s local device....
A class that contains the information of video raw data.