Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDK.h
Go to the documentation of this file.
1//
2// ZoomVideoSDK.h
3// ZoomVideoSDK
4//
5
6#import <UIKit/UIKit.h>
7#import <Foundation/Foundation.h>
8#import <ZoomVideoSDK/ZoomVideoSDKSession.h>
9#import <ZoomVideoSDK/ZoomVideoSDKUser.h>
10#import <ZoomVideoSDK/ZoomVideoSDKDelegate.h>
11#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
12#import <ZoomVideoSDK/ZoomVideoSDKAudioHelper.h>
13#import <ZoomVideoSDK/ZoomVideoSDKVideoHelper.h>
14#import <ZoomVideoSDK/ZoomVideoSDKUserHelper.h>
15#import <ZoomVideoSDK/ZoomVideoSDKVideoCanvas.h>
16#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
17#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
18#import <ZoomVideoSDK/ZoomVideoSDKLiveStreamHelper.h>
19#import <ZoomVideoSDK/ZoomVideoSDKChatHelper.h>
20#import <ZoomVideoSDK/ZoomVideoSDKPhoneHelper.h>
21#import <ZoomVideoSDK/ZoomVideoSDKCmdChannel.h>
22#import <ZoomVideoSDK/ZoomVideoSDKRecordingHelper.h>
23#import <ZoomVideoSDK/ZoomVideoSDKAudioSettingHelper.h>
24#import <ZoomVideoSDK/ZoomVideoSDKTestAudioDeviceHelper.h>
25#import <ZoomVideoSDK/ZoomVideoSDKLiveTranscriptionHelper.h>
26#import <ZoomVideoSDK/ZoomVideoSDKNetworkConnectionHelper.h>
27#import <ZoomVideoSDK/ZoomVideoSDKVirtualBackgroundHelper.h>
28#import <ZoomVideoSDK/ZoomVideoSDKCRCHelper.h>
29#import <ZoomVideoSDK/ZoomVideoSDKMaskHelper.h>
30#import <ZoomVideoSDK/ZoomVideoSDKRemoteCameraControlHelper.h>
31#import <ZoomVideoSDK/ZoomVideoSDKSubSessionHelper.h>
32
37@interface ZoomVideoSDKExtendParams : NSObject
41@property (nonatomic, copy) NSString * _Nullable speakerTestFilePath;
42
43@property (nonatomic, assign) NSInteger wrapperType;
44
45@end
46
51@interface ZoomVideoSDKInitParams : NSObject
55@property (nonatomic, copy) NSString * _Nullable domain;
59@property (nonatomic, copy) NSString * _Nullable logFilePrefix;
63@property (nonatomic, copy) NSString * _Nullable appGroupId;
67@property (nonatomic, assign) BOOL enableLog;
71@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode videoRawdataMemoryMode;
75@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode shareRawdataMemoryMode;
79@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode audioRawdataMemoryMode;
83@property (nonatomic, strong) ZoomVideoSDKExtendParams * _Nullable extendParam;
84@end
85
90@interface ZoomVideoSDKVideoOptions : NSObject
91
95@property (assign, nonatomic) BOOL localVideoOn;
99@property (assign, nonatomic) BOOL multitaskingCameraAccessEnabled;
100
101@end
102
107@interface ZoomVideoSDKAudioOptions : NSObject
108
112@property (assign, nonatomic) BOOL connect;
113
117@property (assign, nonatomic) BOOL mute;
118
122@property (assign, nonatomic) BOOL isMyVoiceInMix;
123
127@property (nonatomic, assign) BOOL autoAdjustSpeakerVolume;
128@end
129
134@interface ZoomVideoSDKSessionContext : NSObject
141@property (nonatomic, copy) NSString * _Nullable sessionName;
145@property (nonatomic, copy) NSString * _Nullable sessionPassword;
149@property (nonatomic, copy) NSString * _Nullable userName;
153@property (nonatomic, copy) NSString * _Nullable token;
160@property (nonatomic, assign) NSInteger sessionIdleTimeoutMins;
164@property (nonatomic, assign) BOOL enable5GHighBandWidth;
168@property (nonatomic, strong) ZoomVideoSDKAudioOptions * _Nullable audioOption;
172@property (nonatomic, strong) ZoomVideoSDKVideoOptions * _Nullable videoOption;
173
177@property (weak, nonatomic) id<ZoomVideoSDKVideoSource> _Nullable externalVideoSourceDelegate;
178
182@property (weak, nonatomic) id<ZoomVideoSDKVideoSourcePreProcessor> _Nullable preProcessorDelegate;
183
187@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioMic> _Nullable virtualAudioMicDelegate;
188
192@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioSpeaker> _Nullable virtualAudioSpeakerDelegate;
193@end
194
201@interface ZoomVideoSDK : NSObject
202
206@property (weak, nonatomic) id<ZoomVideoSDKDelegate> _Nullable delegate;
207
211+ (ZoomVideoSDK * _Nullable)shareInstance;
212
219- (ZoomVideoSDKError)initialize:(ZoomVideoSDKInitParams * _Nonnull)context;
220
226- (ZoomVideoSDKError)cleanup;
227
233- (ZoomVideoSDKSession * _Nullable)joinSession:(ZoomVideoSDKSessionContext * _Nonnull)context;
234
241- (ZoomVideoSDKError)leaveSession:(BOOL)end;
242
247- (ZoomVideoSDKSession * _Nullable)getSession;
248
253- (BOOL)isInSession;
254
259- (NSString * _Nullable)getSDKVersion;
260
265- (NSString * _Nullable)exportLog;
266
271- (ZoomVideoSDKError)cleanAllExportedLogs;
276- (ZoomVideoSDKAudioHelper * _Nullable)getAudioHelper;
277
282- (ZoomVideoSDKVideoHelper * _Nullable)getVideoHelper;
283
288- (ZoomVideoSDKUserHelper * _Nullable)getUserHelper;
289
294- (ZoomVideoSDKShareHelper * _Nullable)getShareHelper;
295
300- (ZoomVideoSDKLiveStreamHelper * _Nullable)getLiveStreamHelper;
301
306- (ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)getIncomingLiveStreamHelper;
307
312- (ZoomVideoSDKChatHelper * _Nullable)getChatHelper;
313
318- (ZoomVideoSDKPhoneHelper * _Nullable)getPhoneHelper;
319
324- (ZoomVideoSDKCmdChannel * _Nullable)getCmdChannel;
325
330- (ZoomVideoSDKRecordingHelper * _Nullable)getRecordingHelper;
331
336- (ZoomVideoSDKAudioSettingHelper * _Nullable)getAudioSettingHelper;
337
342- (ZoomVideoSDKTestAudioDeviceHelper * _Nullable)getTestAudioDeviceHelper;
343
348- (ZoomVideoSDKLiveTranscriptionHelper * _Nullable)getLiveTranscriptionHelper;
349
354- (ZoomVideoSDKVirtualBackgroundHelper * _Nullable)getVirtualBackgroundHelper;
355
360- (ZoomVideoSDKCRCHelper * _Nullable)getCRCHelper;
361
366- (ZoomVideoSDKMaskHelper * _Nullable)getMaskHelper;
367
372- (ZoomVideoSDKSubSessionHelper * _Nullable)getsubSessionHelper;
373
378-(ZoomVideoSDKSessionType)getSessionType;
379
380
381
382@end
ZoomVideoSDKRawDataMemoryMode
Enumeration of memory modes for raw data handling.
ZoomVideoSDKSessionType
Enumeration of session type.
ZoomVideoSDKError
Enumerates all errors in the VideoSDK.
A class to operate the audio action.
The audio option of join session.
A class to operate the instant message in session.
The command channel allows users to send commands or data (such as plain text or a binary encoded int...
ZoomVideoSDK extend params.
NSString *_Nullable speakerTestFilePath
Audio speaker test file path, only support mp3 format.The size cannot exceed 1M.
Zoom Video SDK API manager. Main singleton object that controls the video session creation,...
Parameter class use to initialize the ZoomVideoSDK.
A class to operate the live stream.
Class for using cloud recording in the session. See[ZoomVideoSDK.h#getRecordingHelper].
A Class contains the session information.
Zoom Video SDK session.
Share control interface.
User control interface.
An interface to control video and manage cameras during a video session.
The video option of join session.