zoom-video-sdk-demo/Sample/sdk/mac/ZoomVideoSDK/ZMVideoSDK.framework/Versions/A/Headers/ZMVideoSDK.h

#import <Foundation/Foundation.h>

#import "ZMVideoSDKDelegate.h"
#import "ZMVideoSDKAudioHelper.h"
#import "ZMVideoSDKVideoHelper.h"
#import "ZMVideoSDKUserHelper.h"
#import "ZMVideoSDKShareHelper.h"
#import "ZMVideoSDKLiveStreamHelper.h"
#import "ZMVideoSDKChatHelper.h"
#import "ZMVideoSDKSession.h"
#import "ZMVideoSDKVideoSourceHelper.h"
#import "ZMVideoSDKAudioSendRawdata.h"
#import "ZMVideoSDKChatMessage.h"
#import "ZMVideoSDKPasswordHandler.h"
#import "ZMVideoSDKRecordingHelper.h"
#import "ZMVideoSDKPhoneHelper.h"
#import "ZMVideoSDKCmdChannel.h"
#import "ZMVideoSDKAudioSettingHelper.h"
#import "ZMVideoSDKNetworkConnectionHelper.h"
#import "ZMVideoSDKRecordingConsentHandler.h"
#import "ZMVideoSDKVideoSettingHelper.h"
#import "ZMVideoSDKShareSettingHelper.h"
#import "ZMVideoSDKVideoCanvas.h"
#import "ZMVideoSDKCRCHelper.h"
#import "ZMVideoSDKAnnotationHelper.h"
#import "ZMVideoSDKLiveTranscriptionHelper.h"


@class ZMVideoSDKExtendParams;
/**
 @brief SDK initialized params interface.
 */
@interface ZMVideoSDKInitParams : NSObject
/**
 @brief  Set client domain of ZOOM SDK.
 */
@property (nonatomic, retain, readwrite) NSString* domain;

/**
 @brief Prefix of log file name.
 */
@property (nonatomic, retain, readwrite) NSString* logFilePrefix;

/**
 @brief Set whether to enable default log of which the capacity is less than 5M.
 */
@property (nonatomic, assign, readwrite) BOOL enableLog;

/**
 @brief Set audio raw data memory mode.
 */
@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode audioRawDataMemoryMode;

/**
 @brief Set video raw data memory mode.
 */
@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode videoRawDataMemoryMode;

/**
 @brief Set share raw data memory mode.
 */
@property (nonatomic, assign, readwrite) ZMVideoSDKRawDataMemoryMode shareRawDataMemoryMode;

/**
 @brief teamIdentifier The subject.OU value of the signing certificate. After resign the SDK, you should set the team identifier of your certificate, zoom will verify the certificate when loading.
 */
@property (copy, nonatomic) NSString *teamIdentifier DEPRECATED_MSG_ATTRIBUTE("No longer used");

/**
 @brief Extended parameters.
 */
@property (retain, nonatomic) ZMVideoSDKExtendParams *extendParams;
@end

/*!
 @class ZMVideoSDKExtendParams
 @brief ZMVideoSDK extend params.
 */
@interface ZMVideoSDKExtendParams : NSObject
/*!
 @brief Specify a file path for speaker test.
 @note Only support mp3 format. The size cannot exceed 1M.
 */
@property (nonatomic, copy) NSString *speakerTestFilePath;

/**
 @brief Wrapper type.
 */
@property (nonatomic, assign, readwrite) int wrapperType;
@end


/**
 @brief Video option.
 */
@interface ZMVideoSDKVideoOption : NSObject
/**
 @brief Set local video on or off.
 */
@property (nonatomic, assign, readwrite) BOOL localVideoOn;
@end

/**
 @brief Audio option.
 */
@interface ZMVideoSDKAudioOption : NSObject
/**
 @brief Whether to connect local audio or not.
 */
@property (nonatomic, assign, readwrite) BOOL connect;

/**
 @brief Whether to mute audio or not.
 */
@property (nonatomic, assign, readwrite) BOOL mute;

/**
 @brief Determine whether my voice is in the mixed audio raw data or not. If true, yes, if false, no.
 */
@property (nonatomic, assign, readwrite) BOOL isMyVoiceInMix;

/**
 @brief  Whether to automatically adjust the volume of the speaker or not. If true, this will automatically adjust the volume if it is muted or low. If false it will not.
 */
@property (nonatomic, assign, readwrite) BOOL autoAdjustSpeakerVolume;

@end

/**
 @brief Session context interface.
 */
@interface ZMVideoSDKSessionContext : NSObject

/**
 @brief Session name.
 */
@property (nonatomic, retain, readwrite) NSString* sessionName;

/**
 @brief Session password (optional).
 */
@property (nonatomic, retain, readwrite) NSString* sessionPassword;

/**
 @brief User name(required).
 */
@property (nonatomic, retain, readwrite) NSString* userName;

/**
 @brief JWT token to join session.
 */
@property (nonatomic, retain, readwrite) NSString* token;

/**
 @brief Video option.
 */
@property (nonatomic, retain, readwrite) ZMVideoSDKVideoOption* videoOption;

/**
 @brief Audio option.
 */
@property (nonatomic, retain, readwrite) ZMVideoSDKAudioOption* audioOption;

/**
 @brief Set delegate. (optional).
 */
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSourcePreProcessor> preProcessor;
/**
 @brief Set delegate (optional).
 */
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVideoSource> externalVideoSource;
/**
 @brief Set virtual audio delegate (optional).
 */
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioMic> virtualAudioMic;
/**
 @brief Set virtual audio speaker delegate (optional).
 */
@property (nonatomic, assign, readwrite) id<ZMVideoSDKVirtualAudioSpeaker> virtualAudioSpeaker;
/**
 @brief [Optional] The amount of time in minutes after which an idle session will end.
 *
 * <ul>
 *     <li>Default value: 40</li>
 *     <li>If the value is less than 0, the session will stay alive indefinitely.</li>
 * </ul>
 *
 * When there is only one user remaining in a session, that session is considered idle.
 */
@property (nonatomic, assign, readwrite) unsigned int sessionIdleTimeoutMins;
@end


/** 
 @brief Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK.
 */
@interface ZMVideoSDK : NSObject

/**
 @brief Returns ZMVideoSDK instance.
 @return ZMVideoSDK instance.
 */
+ (ZMVideoSDK*)sharedVideoSDK;
    
/**
 @brief Initialize the Zoom SDK with the appropriate parameters in the {@link ZMVideoSDKInitParams} object.
 @param params It is a init params object, contain all params to init.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)initialize:(ZMVideoSDKInitParams*)params;
    
/**
 @brief Clean up Zoom video sdk.
 */
- (void)cleanUp;
    
/**
 @brief Register a listener for session events.
 @param listener A listener class that groups together all the callbacks related to a session.
 */
- (void)addListener:(id <ZMVideoSDKDelegate>)listener;
    
/**
 @brief Unregister a listener for session events.
 @param listener A listener class that groups together all the callbacks related to a session.
 */
- (void)removeListener:(id <ZMVideoSDKDelegate>)listener;
    
/**
 @brief Call this method to join a session with the appropriate ZMVideoSDKSessionContext parameters. When successful, the SDK will attempt to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.
 @param params It is a session context object, contain all params to join session.
 @return If the function succeeds, the return value is the pointer of session object, otherwise returns nil.
 */
- (ZMVideoSDKSession*)joinSession:(ZMVideoSDKSessionContext*)params;
    
/**
 @brief Call this method to leave a session previously joined through joinSession method call. When successful, the SDK will attempt to leave a session. Use the callbacks in the listener to confirm whether the SDK actually left.
 @param end YES if the host should end the entire session, or NO if the host should just leave the session.
 @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)leaveSession:(BOOL)end;
    
/**
 @brief Returns the current session information.
 @return If the function succeeds, it will return a session object, otherwise returns nil.
 */
- (ZMVideoSDKSession*)getSessionInfo;
    
/**
 @brief Check if there is an active session between participants.
 @return YES means in session, otherwise not.
 */
- (BOOL)isInSession;
    
/**
 @brief Returns Zoom SDK internal version.
 @return If the function succeeds, the return value is sdk version. Otherwise returns nil.
 */
- (NSString*)getSDKVersion;
    
/**
 @brief Returns an instance to manage audio controls related to the current video SDK session.
 @return If the function succeeds, it will return a audio helper object, otherwise returns nil.
 */
- (ZMVideoSDKAudioHelper*)getAudioHelper;
    
/**
 @brief Returns an instance to manage cameras and video during a video SDK session.
 @return If the function succeeds, it will return a video helper object, otherwise returns nil.
 */
- (ZMVideoSDKVideoHelper*)getVideoHelper;
    
/**
 @brief Returns an instance to manage users present in a video SDK session.
 @return If the function succeeds, it will return a user helper object, otherwise returns nil.
 */
- (ZMVideoSDKUserHelper*)getUserHelper;
    
/**
 @brief Returns an instance to manage screen sharing during a video SDK session.
 @return If the function succeeds, it will return a share helper object, otherwise returns nil.
 */
- (ZMVideoSDKShareHelper*)getShareHelper;
    
/**
 @brief Returns an instance to manage live streaming during a video SDK session.
 @return If the function succeeds, it will return a live stream helper object, otherwise returns nil.
 */
- (ZMVideoSDKLiveStreamHelper*)getLiveStreamHelper;
    
/**
 @brief Returns an instance to send and receive chat messages within video SDK session participants.
 @return If the function succeeds, it will return a chat helper object, otherwise returns nil.
 */
- (ZMVideoSDKChatHelper*)getChatHelper;

/**
 @brief Returns an instance to manage cloud recordings during a video SDK session.
 @return If the function succeeds, it will return a {@link ZMVideoSDKRecordingHelper} instance.
 */
- (ZMVideoSDKRecordingHelper*)getRecordingHelper;

/**
 @brief Returns an instance to use command channel features during a video SDK session.
 @return If the function succeeds, it will return a {@link ZMVideoSDKCmdChannel} instance.
 */
- (ZMVideoSDKCmdChannel*)getCmdChannel;

/**
 @brief Returns an instance to manage phone invitations during a video SDK session.
 @return If the function succeeds, it will return a phone helper object, otherwise returns nil.
 */
- (ZMVideoSDKPhoneHelper*)getPhoneHelper;

/**
 @brief Returns an instance to manage audio setting during or before a video SDK session.
 @return If the function succeeds, it will return an audio setting helper object, otherwise returns nil.
 */
- (ZMVideoSDKAudioSettingHelper*)getAudioSettingHelper;

/**
 @brief Returns an instance to manage audio device test during or before a video SDK session.
 @return If the function succeeds, it will return an audio device test helper object, otherwise returns nil.
 */
- (ZMVideoSDKAudioDeviceTestHelper*)getAudioDeviceTestHelper;

/**
 @brief Returns an instance to manage network connection during or before a video SDK session.
 @return If the function succeeds, it will return an network connection helper object, otherwise returns nil.
 */
- (ZMVideoSDKNetworkConnectionHelper*)getNetworkConnectionHelper;

/**
 @brief Get video setting helper object.
 @return If the function succeeds, the return value is the video setting helper object. Otherwise returns nil.
 */
- (ZMVideoSDKVideoSettingHelper*)getVideoSettingHelper;

/**
 @brief Get share setting helper object.
 @return If the function succeeds, the return value is the share setting helper object. Otherwise returns nil.
 */
- (ZMVideoSDKShareSettingHelper*)getShareSettingHelper;

/**
 @brief Get crc helper object.
 @return If the function succeeds, the return value is the crc helper object. Otherwise returns nil.
 */
- (ZMVideoSDKCRCHelper*)getCRCHelper;

/**
 @brief Get live transcription helper object.
 @return If the function succeeds, the return value is the live transcription helper object. Otherwise, this function returns NULL. For more details, refer to {@link ZMVideoSDKLiveTranscriptionHelper}.
 */
- (ZMVideoSDKLiveTranscriptionHelper*)getLiveTranscriptionHelper;
@end