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
49
50@end
51
56@interface ZoomVideoSDKInitParams : NSObject
60@property (nonatomic, copy) NSString * _Nullable domain;
64@property (nonatomic, copy) NSString * _Nullable logFilePrefix;
68@property (nonatomic, copy) NSString * _Nullable appGroupId;
72@property (nonatomic, assign) BOOL enableLog;
76@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode videoRawdataMemoryMode;
80@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode shareRawdataMemoryMode;
84@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode audioRawdataMemoryMode;
88@property (nonatomic, strong) ZoomVideoSDKExtendParams * _Nullable extendParam;
89@end
90
95@interface ZoomVideoSDKVideoOptions : NSObject
96
100@property (assign, nonatomic) BOOL localVideoOn;
104@property (assign, nonatomic) BOOL multitaskingCameraAccessEnabled;
105
106@end
107
112@interface ZoomVideoSDKAudioOptions : NSObject
113
117@property (assign, nonatomic) BOOL connect;
118
122@property (assign, nonatomic) BOOL mute;
123
127@property (assign, nonatomic) BOOL isMyVoiceInMix;
128
132@property (nonatomic, assign) BOOL autoAdjustSpeakerVolume;
133@end
134
139@interface ZoomVideoSDKSessionContext : NSObject
145@property (nonatomic, copy) NSString * _Nullable sessionName;
149@property (nonatomic, copy) NSString * _Nullable sessionPassword;
153@property (nonatomic, copy) NSString * _Nullable userName;
157@property (nonatomic, copy) NSString * _Nullable token;
162@property (nonatomic, assign) NSInteger sessionIdleTimeoutMins;
166@property (nonatomic, assign) BOOL enable5GHighBandWidth;
170@property (nonatomic, strong) ZoomVideoSDKAudioOptions * _Nullable audioOption;
174@property (nonatomic, strong) ZoomVideoSDKVideoOptions * _Nullable videoOption;
175
179@property (weak, nonatomic) id<ZoomVideoSDKVideoSource> _Nullable externalVideoSourceDelegate;
180
184@property (weak, nonatomic) id<ZoomVideoSDKVideoSourcePreProcessor> _Nullable preProcessorDelegate;
185
189@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioMic> _Nullable virtualAudioMicDelegate;
190
194@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioSpeaker> _Nullable virtualAudioSpeakerDelegate;
195@end
196
203@interface ZoomVideoSDK : NSObject
204
208@property (weak, nonatomic) id<ZoomVideoSDKDelegate> _Nullable delegate;
209
213+ (ZoomVideoSDK * _Nullable)shareInstance;
214
221- (ZoomVideoSDKError)initialize:(ZoomVideoSDKInitParams * _Nonnull)context;
222
228- (ZoomVideoSDKError)cleanup;
229
235- (ZoomVideoSDKSession * _Nullable)joinSession:(ZoomVideoSDKSessionContext * _Nonnull)context;
236
243- (ZoomVideoSDKError)leaveSession:(BOOL)end;
244
249- (ZoomVideoSDKSession * _Nullable)getSession;
250
255- (BOOL)isInSession;
256
261- (NSString * _Nullable)getSDKVersion;
262
267- (NSString * _Nullable)exportLog;
268
273- (ZoomVideoSDKError)cleanAllExportedLogs;
278- (ZoomVideoSDKAudioHelper * _Nullable)getAudioHelper;
279
284- (ZoomVideoSDKVideoHelper * _Nullable)getVideoHelper;
285
290- (ZoomVideoSDKUserHelper * _Nullable)getUserHelper;
291
296- (ZoomVideoSDKShareHelper * _Nullable)getShareHelper;
297
302- (ZoomVideoSDKLiveStreamHelper * _Nullable)getLiveStreamHelper;
303
308- (ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)getIncomingLiveStreamHelper;
309
314- (ZoomVideoSDKChatHelper * _Nullable)getChatHelper;
315
320- (ZoomVideoSDKPhoneHelper * _Nullable)getPhoneHelper;
321
326- (ZoomVideoSDKCmdChannel * _Nullable)getCmdChannel;
327
332- (ZoomVideoSDKRecordingHelper * _Nullable)getRecordingHelper;
333
338- (ZoomVideoSDKAudioSettingHelper * _Nullable)getAudioSettingHelper;
339
344- (ZoomVideoSDKTestAudioDeviceHelper * _Nullable)getTestAudioDeviceHelper;
345
350- (ZoomVideoSDKLiveTranscriptionHelper * _Nullable)getLiveTranscriptionHelper;
351
356- (ZoomVideoSDKVirtualBackgroundHelper * _Nullable)getVirtualBackgroundHelper;
357
362- (ZoomVideoSDKCRCHelper * _Nullable)getCRCHelper;
363
368- (ZoomVideoSDKMaskHelper * _Nullable)getMaskHelper;
369
374- (ZoomVideoSDKSubSessionHelper * _Nullable)getsubSessionHelper;
375
380-(ZoomVideoSDKSessionType)getSessionType;
381
382
383
384@end
ZoomVideoSDKPreferVideoResolution
Enumeration of preferred video resolution in Zoom Video SDK.
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.
Helper interface for Cloud Room Connector (CRC) features.
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 in...
ZoomVideoSDK extend params.
ZoomVideoSDKPreferVideoResolution preferVideoResolution
Prefer video resolution.
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,...
Incoming live stream helper interface.
Parameter class use to initialize the ZoomVideoSDK.
A class to operate the live stream.
Provides methods for controlling and interacting with live transcription.
The helper to set the video mask.
Provides methods for managing phone-related session features such as dial-in and phone invites.
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.