Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKShareHelper.h
Go to the documentation of this file.
1
5
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;
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
122
131- (ZoomVideoSDKError)startSharingExternalSource:(id<ZoomVideoSDKShareSource> _Nullable)shareDelegate andAudioSource:(id <ZoomVideoSDKShareAudioSource> _Nullable)audioDelegate isPlaying:(BOOL)isPlaying;
132
138- (ZoomVideoSDKError)enablePlaySharingAudioRawdata:(BOOL)bPlay;
139
146
152
158
164- (ZoomVideoSDKError)lockShare:(BOOL)lock;
165
171
177
183
189
195
201- (BOOL)enableShareDeviceAudio:(BOOL)enable;
202
208
215- (ZoomVideoSDKError)disableViewerAnnotation:(BOOL)disable;
216
223
231- (ZoomVideoSDKAnnotationHelper * _Nullable)createAnnotationHelper:(UIView * _Nullable)view;
232
238- (ZoomVideoSDKError)destroyAnnotationHelper:(ZoomVideoSDKAnnotationHelper * _Nullable)helper;
239
247- (ZoomVideoSDKError)setAnnotationVanishingToolTime:(NSUInteger)displayTime vanishingTime:(NSUInteger)vanishingTime;
248
255
262
263#pragma mark - multi share -
270- (ZoomVideoSDKError)enableMultiShare:(BOOL)enable;
271
277
278#pragma mark - share camera and anno -
285- (ZoomVideoSDKError)startShareCamera:(UIView *_Nullable)parentView API_UNAVAILABLE(visionos);
286
287#pragma mark - share with pre-process -
296- (ZoomVideoSDKError)startShareWithPreprocessing:(ZoomVideoSDKSharePreprocessParam * _Nullable)param sharePreprocessor:(id<ZoomVideoSDKSharePreprocessor> _Nullable)preProcessDelegate;
297
303- (ZoomVideoSDKError)applyPreprocessingOverlayImage:(UIImage *_Nullable)image;
304
310
311#pragma mark - in-app screen share -
312
318
324
331
338- (ZoomVideoSDKError)setAnnotationView:(UIView *_Nullable)annoParentView;
339
345- (ZoomVideoSDKError)limitShareSendingResolutionToFullHD:(BOOL)limit;
346
347@end
348
349
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.
BOOL isAnnotationPrivilegeEnabled()
Determines whether annotation privilege is enabled.
ZoomVideoSDKSubscribeFailReason getSubscribeFailReason()
Gets the subscribe fail reason.
NSInteger getShareSourceId()
Gets the share source ID.
ZoomVideoSDKShareType getShareType()
Gets the share type.
ZoomVideoSDKReceiveSharingStatus getShareStatus()
Gets the share status.
ZoomVideoSDKRawDataPipe *_Nullable getSharePipe()
Gets the share raw data pipe.
CGSize getShareSourceContentSize()
Gets the size of the share content.
ZoomVideoSDKVideoCanvas *_Nullable getShareCanvas()
Gets the render canvas object.
Share control interface.
NSUInteger getAnnotationVanishingToolVanishingTime()
Gets the current vanishing tool vanishing time.
ZoomVideoSDKError stopShare()
Stops view or screen share.
void removePreprocessingOverlayImage()
Removes the currently applied UIImage overlay from the shared image stream when using (when you share...
BOOL isViewerAnnotationDisabled()
Determines whether annotation on current sharing is disabled.
BOOL isSharingOut()
Determines whether the current user is sharing.
NSUInteger getAnnotationVanishingToolDisplayTime()
Gets the current vanishing tool display time.
ZoomVideoSDKError pauseShare()
Pauses share. For camera share, the presenter can pause the share to support annotation.
ZoomVideoSDKError resumeShare()
Resumes share. For camera share, the presenter can restart the camera share.
BOOL isOtherSharing()
Determines whether another user is sharing.
BOOL isInAppScreenShareInProgress()
Determines whether the in-app screen share is in progress.
BOOL isShareLocked()
Determines whether sharing the view or screen is locked.
ZoomVideoSDKError startInAppScreenShare()
Start in-app screen share.
BOOL isScreenSharingOut()
Determines whether the current user is sharing the screen.
BOOL isSupportInAppScreenShare()
Determines whether the system supports in-app screen share.
BOOL isAnnotationFeatureSupport()
Determines whether annotation feature is supported.
BOOL isMultiShareEnabled()
Determines whether multi share is enabled.
BOOL isShareDeviceAudioEnabled()
Determines whether the SDK has enabled share device audio when screen sharing.
Start pre-process share's parameter.
UIView * view
Gets the view to share and pre-process. No need to pass when type is none.
ZoomVideoSDKSharePreprocessType type
Gets the preprocess type.
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.