ZoomVideoSDK.h

Go to the documentation of this file.

 
#import <UIKit/UIKit.h>
#import <Foundation/Foundation.h>
#import <ZoomVideoSDK/ZoomVideoSDKSession.h>
#import <ZoomVideoSDK/ZoomVideoSDKUser.h>
#import <ZoomVideoSDK/ZoomVideoSDKDelegate.h>
#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
#import <ZoomVideoSDK/ZoomVideoSDKAudioHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKUserHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoCanvas.h>
#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKLiveStreamHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKChatHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKPhoneHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKCmdChannel.h>
#import <ZoomVideoSDK/ZoomVideoSDKRecordingHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKAudioSettingHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoSettingHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKTestAudioDeviceHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKLiveTranscriptionHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKVoiceInterpretationHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKNetworkConnectionHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKVirtualBackgroundHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKCRCHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKMaskHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKRemoteCameraControlHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKSubSessionHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKWhiteboardHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKBroadcastStreamingHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKEmojiReactionHelper.h>
#import <ZoomVideoSDK/ZoomVideoRealTimeMediaStreamsHelper.h>

@interface ZoomVideoSDKExtendParams : NSObject
@property (nonatomic, copy) NSString * _Nullable speakerTestFilePath;

@property (nonatomic, assign) NSInteger wrapperType;

@property (nonatomic, assign) ZoomVideoSDKPreferVideoResolution preferVideoResolution;
 
@end

@interface ZoomVideoSDKInitParams : NSObject
@property (nonatomic, copy) NSString * _Nullable domain;
@property (nonatomic, copy) NSString * _Nullable logFilePrefix;
@property (nonatomic, copy) NSString * _Nullable  appGroupId;
@property (nonatomic, assign) BOOL                          enableLog;
@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode  videoRawdataMemoryMode;
@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode  shareRawdataMemoryMode;
@property (nonatomic, assign) ZoomVideoSDKRawDataMemoryMode  audioRawdataMemoryMode;
@property (nonatomic, strong) ZoomVideoSDKExtendParams * _Nullable extendParam;
@end

@interface ZoomVideoSDKVideoOptions : NSObject

@property (assign, nonatomic) BOOL localVideoOn;
@property (assign, nonatomic) BOOL multitaskingCameraAccessEnabled;
 
@end

@interface ZoomVideoSDKAudioOptions : NSObject

@property (assign, nonatomic) BOOL connect;

@property (assign, nonatomic) BOOL mute;

@property (assign, nonatomic) BOOL isMyVoiceInMix;

@property (nonatomic, assign) BOOL autoAdjustSpeakerVolume;
@end

@interface ZoomVideoSDKSessionContext : NSObject
@property (nonatomic, copy) NSString * _Nullable sessionName;
@property (nonatomic, copy) NSString * _Nullable sessionPassword;
@property (nonatomic, copy) NSString * _Nullable userName;
@property (nonatomic, copy) NSString * _Nullable token;
@property (nonatomic, assign) NSInteger sessionIdleTimeoutMins;
@property (nonatomic, assign) BOOL enable5GHighBandWidth;
@property (nonatomic, strong) ZoomVideoSDKAudioOptions * _Nullable audioOption;
@property (nonatomic, strong) ZoomVideoSDKVideoOptions * _Nullable videoOption;

@property (weak, nonatomic) id<ZoomVideoSDKVideoSource> _Nullable externalVideoSourceDelegate;

@property (weak, nonatomic) id<ZoomVideoSDKVideoSourcePreProcessor> _Nullable preProcessorDelegate;

@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioMic> _Nullable virtualAudioMicDelegate;

@property (weak, nonatomic) id<ZoomVideoSDKVirtualAudioSpeaker> _Nullable virtualAudioSpeakerDelegate;

@property (nonatomic, assign) BOOL autoLoadMutliStream;
@property (nonatomic, assign) ZoomVideoSDKFrameDataFormat externalVideoSourceDataFormat;
@end

@interface ZoomVideoSDKPreJoinParam : NSObject
@property (nonatomic, assign) NSUInteger timeoutInterval;
@end

@interface ZoomVideoSDK : NSObject

@property (weak, nonatomic) id<ZoomVideoSDKDelegate> _Nullable delegate;

+ (ZoomVideoSDK * _Nullable)shareInstance DEPRECATED_MSG_ATTRIBUTE("Use sharedInstance instead");

+ (ZoomVideoSDK * _Nullable)sharedInstance;

- (ZoomVideoSDKError)initialize:(ZoomVideoSDKInitParams * _Nonnull)context;

- (ZoomVideoSDKError)cleanup;

- (ZoomVideoSDKSession * _Nullable)joinSession:(ZoomVideoSDKSessionContext * _Nonnull)context;

- (ZoomVideoSDKSession * _Nullable)prepareJoin:(ZoomVideoSDKSessionContext * _Nonnull)context preJoinParam:(ZoomVideoSDKPreJoinParam * _Nonnull)preJoinParam;

- (ZoomVideoSDKError)commitJoin;

- (ZoomVideoSDKError)cancelPrepareJoin;

- (ZoomVideoSDKError)leaveSession:(BOOL)end;

- (ZoomVideoSDKSession * _Nullable)getSession;

- (BOOL)isInSession;

- (NSString * _Nullable)getSDKVersion;

- (NSString * _Nullable)exportLog;

- (ZoomVideoSDKError)cleanAllExportedLogs;
- (ZoomVideoSDKAudioHelper * _Nullable)getAudioHelper;

- (ZoomVideoSDKVideoHelper * _Nullable)getVideoHelper;

- (ZoomVideoSDKUserHelper * _Nullable)getUserHelper;

- (ZoomVideoSDKShareHelper * _Nullable)getShareHelper;

- (ZoomVideoSDKLiveStreamHelper * _Nullable)getLiveStreamHelper;

- (ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)getIncomingLiveStreamHelper;

- (ZoomVideoSDKChatHelper * _Nullable)getChatHelper;

- (ZoomVideoSDKPhoneHelper * _Nullable)getPhoneHelper;

- (ZoomVideoSDKCmdChannel * _Nullable)getCmdChannel;

- (ZoomVideoSDKRecordingHelper * _Nullable)getRecordingHelper;

- (ZoomVideoSDKAudioSettingHelper * _Nullable)getAudioSettingHelper;

- (ZoomVideoSDKVideoSettingHelper * _Nullable)getVideoSettingHelper;

- (ZoomVideoSDKTestAudioDeviceHelper * _Nullable)getTestAudioDeviceHelper;

- (ZoomVideoSDKLiveTranscriptionHelper * _Nullable)getLiveTranscriptionHelper;

- (ZoomVideoSDKVoiceInterpretationHelper * _Nullable)getVoiceInterpretationHelper;

- (ZoomVideoSDKVirtualBackgroundHelper * _Nullable)getVirtualBackgroundHelper;

- (ZoomVideoSDKCRCHelper * _Nullable)getCRCHelper;

- (ZoomVideoSDKMaskHelper * _Nullable)getMaskHelper;

- (ZoomVideoSDKSubSessionHelper * _Nullable)getsubSessionHelper;

-(ZoomVideoSDKSessionType)getSessionType DEPRECATED_MSG_ATTRIBUTE("use -[ZoomVideoSDKSession getSessionType] instead");

- (ZoomVideoSDKBroadcastStreamingHelper *_Nullable)getBroadcastStreamingHelper;

- (ZoomVideoSDKBroadcastStreamingViewerHelper * _Nullable)getBroadcastStreamingViewerHelper;

- (ZoomVideoSDKEmojiReactionHelper * _Nullable)getEmojiReactionHelper;

- (ZoomVideoSDKWhiteboardHelper * _Nullable)getWhiteboardHelper  API_UNAVAILABLE(visionos);

- (ZoomVideoRealTimeMediaStreamsHelper * _Nullable)getRealTimeMediaStreamsHelper;
 
@end