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
80@property (nonatomic, assign) ZoomVideoSDKSharePreprocessType type;
84@property (nonatomic, weak) UIView *view;
85@end
86
92
98- (ZoomVideoSDKError)sendPreprocessedData:(ZoomVideoSDKVideoRawData * _Nullable)rawData;
99
100@end
101
102
103
108@interface ZoomVideoSDKShareHelper : NSObject
109
117- (ZoomVideoSDKError)startShareWithView:(UIView * _Nullable)view;
118
127- (ZoomVideoSDKError)startSharingExternalSource:(id<ZoomVideoSDKShareSource> _Nullable)shareDelegate andAudioSource:(id <ZoomVideoSDKShareAudioSource> _Nullable)audioDelegate DEPRECATED_MSG_ATTRIBUTE("use startSharingExternalSource:andAudioSource:isPlaying: instead");
128
137- (ZoomVideoSDKError)startSharingExternalSource:(id<ZoomVideoSDKShareSource> _Nullable)shareDelegate andAudioSource:(id <ZoomVideoSDKShareAudioSource> _Nullable)audioDelegate isPlaying:(BOOL)isPlaying;
138
144- (ZoomVideoSDKError)enablePlaySharingAudioRawdata:(BOOL)bPlay;
145
150- (ZoomVideoSDKError)stopShare;
151
156- (ZoomVideoSDKError)pauseShare;
157
162- (ZoomVideoSDKError)resumeShare;
163
170- (ZoomVideoSDKError)lockShare:(BOOL)lock;
171
176- (BOOL)isShareLocked;
177
182- (BOOL)isSharingOut;
183
188- (BOOL)isOtherSharing;
189
194- (BOOL)isScreenSharingOut;
195
200- (BOOL)isShareDeviceAudioEnabled;
201
207- (BOOL)enableShareDeviceAudio:(BOOL)enable;
208
213- (BOOL)isAnnotationFeatureSupport;
214
221- (ZoomVideoSDKError)disableViewerAnnotation:(BOOL)disable;
222
228- (BOOL)isViewerAnnotationDisabled;
229
236- (ZoomVideoSDKAnnotationHelper * _Nullable)createAnnotationHelper:(UIView * _Nullable)view;
237
243- (ZoomVideoSDKError)destroyAnnotationHelper:(ZoomVideoSDKAnnotationHelper * _Nullable)helper;
244
253- (ZoomVideoSDKError)setAnnotationVanishingToolTime:(NSUInteger)displayTime vanishingTime:(NSUInteger)vanishingTime;
254
260- (NSUInteger)getAnnotationVanishingToolDisplayTime;
261
267- (NSUInteger)getAnnotationVanishingToolVanishingTime;
268
269#pragma mark - multi share -
276- (ZoomVideoSDKError)enableMultiShare:(BOOL)enable;
277
282- (BOOL)isMultiShareEnabled;
283
284#pragma mark - share camera and anno -
291- (ZoomVideoSDKError)startShareCamera:(UIView *_Nullable)parentView API_UNAVAILABLE(visionos);
292
293
294#pragma mark - share with pre-process -
303- (ZoomVideoSDKError)startShareWithPreprocessing:(ZoomVideoSDKSharePreprocessParam * _Nullable)param sharePreprocessor:(id<ZoomVideoSDKSharePreprocessor> _Nullable)preProcessDelegate;
304
310- (ZoomVideoSDKError)applyPreprocessingOverlayImage:(UIImage *_Nullable)image;
311
316- (void)removePreprocessingOverlayImage;
317
318#pragma mark - in-app screen share -
319
324- (BOOL)isSupportInAppScreenShare;
325
331- (ZoomVideoSDKError)startInAppScreenShare;
332
339- (ZoomVideoSDKError)setAnnotationView:(UIView *_Nullable)shareView;
340
341@end
342
343
ZoomVideoSDKSubscribeFailReason
Enumerates the reasons for a failed video subscription attempt.
ZoomVideoSDKSharePreprocessType
Enumeration of share preprocess types.
ZoomVideoSDKReceiveSharingStatus
Enumerates the status of sharing.
ZoomVideoSDKShareType
Enumerates the types of content that can be shared in a session.
ZoomVideoSDKError
Enumerates all 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.
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 contains the information of video raw data.