Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKShareHelper.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKShareHelper.h
3// ZoomVideoSDK
4//
5// Created by Zoom Video Communications on 2018/12/13.
6// Copyright © Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <ZoomVideoSDK/ZoomVideoSDKAnnotationHelper.h>
11
12@protocol ZoomVideoSDKShareSource;
13@protocol ZoomVideoSDKShareAudioSource;
14@protocol ZoomVideoSDKSharePreprocessor;
19@interface ZoomVideoSDKShareStatus : NSObject
23@property (nonatomic, assign) ZoomVideoSDKReceiveSharingStatus sharingStatus;
24
25@end
26
29
34@interface ZoomVideoSDKShareAction : NSObject
39- (NSInteger)getShareSourceId;
44- (ZoomVideoSDKVideoCanvas *_Nullable)getShareCanvas;
49- (ZoomVideoSDKReceiveSharingStatus )getShareStatus;
54- (ZoomVideoSDKRawDataPipe *_Nullable)getSharePipe;
59- (ZoomVideoSDKSubscribeFailReason)getSubscribeFailReason;
64- (BOOL)isAnnotationPrivilegeEnabled;
69- (ZoomVideoSDKShareType)getShareType;
74- (CGSize)getShareSourceContentSize;
75
76@end
77
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
254- (ZoomVideoSDKError)enableMultiShare:(BOOL)enable;
255
260- (BOOL)isMultiShareEnabled;
261
262#pragma mark - share camera and anno -
269- (ZoomVideoSDKError)startShareCamera:(UIView *_Nullable)parentView;
270
271
272#pragma mark - share with pre-process -
281- (ZoomVideoSDKError)startShareWithPreprocessing:(ZoomVideoSDKSharePreprocessParam * _Nullable)param sharePreprocessor:(id<ZoomVideoSDKSharePreprocessor> _Nullable)preProcessDelegate;
282@end
283
284
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.