ZMVideoSDK.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZMVideoSDK/ZMVideoSDKDelegate.h>
#import <ZMVideoSDK/ZMVideoSDKAudioHelper.h>
#import <ZMVideoSDK/ZMVideoSDKVideoHelper.h>
#import <ZMVideoSDK/ZMVideoSDKUserHelper.h>
#import <ZMVideoSDK/ZMVideoSDKShareHelper.h>
#import <ZMVideoSDK/ZMVideoSDKLiveStreamHelper.h>
#import <ZMVideoSDK/ZMVideoSDKChatHelper.h>
#import <ZMVideoSDK/ZMVideoSDKSession.h>
#import <ZMVideoSDK/ZMVideoSDKVideoSourceHelper.h>
#import <ZMVideoSDK/ZMVideoSDKAudioSendRawdata.h>
#import <ZMVideoSDK/ZMVideoSDKChatMessage.h>
#import <ZMVideoSDK/ZMVideoSDKPasswordHandler.h>
#import <ZMVideoSDK/ZMVideoSDKRecordingHelper.h>
#import <ZMVideoSDK/ZMVideoSDKPhoneHelper.h>
#import <ZMVideoSDK/ZMVideoSDKCmdChannel.h>
#import <ZMVideoSDK/ZMVideoSDKAudioSettingHelper.h>
#import <ZMVideoSDK/ZMVideoSDKNetworkConnectionHelper.h>
#import <ZMVideoSDK/ZMVideoSDKRecordingConsentHandler.h>
#import <ZMVideoSDK/ZMVideoSDKVideoSettingHelper.h>
#import <ZMVideoSDK/ZMVideoSDKShareSettingHelper.h>
#import <ZMVideoSDK/ZMVideoSDKVideoCanvas.h>
#import <ZMVideoSDK/ZMVideoSDKCRCHelper.h>
#import <ZMVideoSDK/ZMVideoSDKAnnotationHelper.h>
#import <ZMVideoSDK/ZMVideoSDKLiveTranscriptionHelper.h>
#import <ZMVideoSDK/ZMVideoSDKVoiceInterpretationHelper.h>
#import <ZMVideoSDK/ZMVideoSDKSubSessionHelper.h>
#import <ZMVideoSDK/ZMVideoSDKBroadcastStreamingController.h>
#import <ZMVideoSDK/ZMVideoSDKBroadcastStreamingViewer.h>
#import <ZMVideoSDK/ZMVideoSDKEmojiReactionHelper.h>
#import <ZMVideoSDK/ZMVideoSDKRTMSHelper.h>
 
NS_ASSUME_NONNULL_BEGIN
@class ZMVideoSDKExtendParams;

@interface ZMVideoSDKInitParams : NSObject
@property (nonatomic, retain, readwrite, nullable) NSString* domain;

@property (nonatomic, retain, readwrite, nullable) NSString* logFilePrefix;

@property (nonatomic, assign, readwrite) BOOL enableLog;

@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode audioRawDataMemoryMode;

@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode videoRawDataMemoryMode;

@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode shareRawDataMemoryMode;

@property (retain, nonatomic, nullable) ZMVideoSDKExtendParams *extendParams;
@end

@interface ZMVideoSDKExtendParams : NSObject
@property (nonatomic, copy, nullable) NSString *speakerTestFilePath;

@property (nonatomic, assign, readwrite) int wrapperType;

@property (nonatomic, assign, readwrite) ZMVideoSDKPreferVideoResolution preferVideoResolution;

@property (nonatomic, assign, readwrite) BOOL disableKeychainAccess;
@end
 

@interface ZMVideoSDKVideoOption : NSObject
@property (nonatomic, assign, readwrite) BOOL localVideoOn;
@end

@interface ZMVideoSDKAudioOption : NSObject
@property (nonatomic, assign, readwrite) BOOL connect;

@property (nonatomic, assign, readwrite) BOOL mute;

@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;

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

@interface ZMVideoSDKSessionContext : NSObject

@property (nonatomic, retain, readwrite, nullable) NSString* sessionName;

@property (nonatomic, retain, readwrite, nullable) NSString* sessionPassword;

@property (nonatomic, retain, readwrite, nullable) NSString* userName;

@property (nonatomic, retain, readwrite, nullable) NSString* token;

@property (nonatomic, retain, readwrite, nullable) ZMVideoSDKVideoOption* videoOption;

@property (nonatomic, retain, readwrite, nullable) ZMVideoSDKAudioOption* audioOption;

@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSourcePreProcessor> preProcessor;
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSource> externalVideoSource;
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioMic> virtualAudioMic;
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioSpeaker> virtualAudioSpeaker;
@property (nonatomic, assign, readwrite) unsigned int sessionIdleTimeoutMins;
@property (nonatomic, assign, readwrite) BOOL autoLoadMutliStream;
@property (nonatomic, assign, readwrite) ZMVideoSDKFrameDataFormat externalVideoSourceDataFormat;
@end

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

@interface ZMVideoSDK : NSObject

+ (ZMVideoSDK*)sharedVideoSDK;
    
- (ZMVideoSDKErrors)initialize:(ZMVideoSDKInitParams*)params;
    
- (ZMVideoSDKErrors)cleanUp;
    
- (void)addListener:(id <ZMVideoSDKDelegate>)listener;
    
- (void)removeListener:(id <ZMVideoSDKDelegate>)listener;
    
- (ZMVideoSDKSession* _Nullable)joinSession:(ZMVideoSDKSessionContext*)params;

- (ZMVideoSDKSession* _Nullable)prepareJoin:(ZMVideoSDKSessionContext*)params preJoinParam:(ZMVideoSDKPreJoinParam*)preJoinParam;

- (ZMVideoSDKErrors)commitJoin;

- (ZMVideoSDKErrors)cancelPrepareJoin;

- (ZMVideoSDKErrors)leaveSession:(BOOL)end;
    
- (ZMVideoSDKSession* _Nullable)getSessionInfo;
    
- (BOOL)isInSession;
    
- (NSString* _Nullable)getSDKVersion;

- (NSString* _Nullable)exportLog;

- (ZMVideoSDKErrors)cleanAllExportedLogs;

- (ZMVideoSDKAudioHelper*)getAudioHelper;
    
- (ZMVideoSDKVideoHelper*)getVideoHelper;
    
- (ZMVideoSDKUserHelper*)getUserHelper;
    
- (ZMVideoSDKShareHelper*)getShareHelper;
    
- (ZMVideoSDKLiveStreamHelper*)getLiveStreamHelper;
    
- (ZMVideoSDKChatHelper*)getChatHelper;

- (ZMVideoSDKRecordingHelper*)getRecordingHelper;

- (ZMVideoSDKCmdChannel*)getCmdChannel;

- (ZMVideoSDKPhoneHelper*)getPhoneHelper;

- (ZMVideoSDKAudioSettingHelper*)getAudioSettingHelper;

- (ZMVideoSDKAudioDeviceTestHelper*)getAudioDeviceTestHelper;

- (ZMVideoSDKNetworkConnectionHelper*)getNetworkConnectionHelper;

- (ZMVideoSDKVideoSettingHelper*)getVideoSettingHelper;

- (ZMVideoSDKShareSettingHelper*)getShareSettingHelper;

- (ZMVideoSDKCRCHelper*)getCRCHelper;

- (ZMVideoSDKLiveTranscriptionHelper*)getLiveTranscriptionHelper;

- (ZMVideoSDKVoiceInterpretationHelper*)getVoiceInterpretationHelper;

- (ZMVideoSDKIncomingLiveStreamHelper*)getIncomingLiveStreamHelper;

- (ZMVideoSDKSubSessionHelper* _Nullable)getSubSessionHelper;

- (ZMVideoSDKBroadcastStreamingController* _Nullable)getBroadcastStreamingController;

- (ZMVideoSDKBroadcastStreamingViewer* _Nullable)getBroadcastStreamingViewer;

- (ZMVideoSDKEmojiReactionHelper* _Nullable)getEmojiReactionHelper;

- (ZMVideoSDKRTMSHelper* _Nullable)getRealTimeMediaStreamsHelper;
@end
NS_ASSUME_NONNULL_END