ZoomSDKMeetingService.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZoomSDK/ZoomSDKErrors.h>
#import <ZoomSDK/ZoomSDKH323Helper.h>
#import <ZoomSDK/ZoomSDKPhoneHelper.h>
#import <ZoomSDK/ZoomSDKWaitingRoomController.h>
#import <ZoomSDK/ZoomSDKMeetingUIController.h>
#import <ZoomSDK/ZoomSDKMeetingConfiguration.h>
#import <ZoomSDK/ZoomSDKASController.h>
#import <ZoomSDK/ZoomSDKMeetingActionController.h>
#import <ZoomSDK/ZoomSDKLiveStreamHelper.h>
#import <ZoomSDK/ZoomSDKVideoContainer.h>
#import <ZoomSDK/ZoomSDKMeetingRecordController.h>
#import <ZoomSDK/ZoomSDKWebinarController.h>
#import <ZoomSDK/ZoomSDKCloseCaptionController.h>
#import <ZoomSDK/ZoomSDKRealNameAuthenticationController.h>
#import <ZoomSDK/ZoomSDKQAController.h>
#import <ZoomSDK/ZoomSDKNewBreakoutRoomController.h>
#import <ZoomSDK/ZoomSDKInterpretationController.h>
#import <ZoomSDK/ZoomSDKReactionController.h>
#import <ZoomSDK/ZoomSDKAppSignalController.h>
#import <ZoomSDK/ZoomSDKRawArchivingController.h>
#import <ZoomSDK/ZoomSDKSignInterpretationController.h>
#import <ZoomSDK/ZoomSDKCustomImmersiveController.h>
#import <ZoomSDK/ZoomSDKMeetingChatController.h>
#import <ZoomSDK/ZoomSDKMeetingWhiteboardController.h>
#import <ZoomSDK/ZoomSDKMeetingEncryptionController.h>
#import <ZoomSDK/ZoomSDKPollingController.h>
#import <ZoomSDK/ZoomSDKMeetingRemoteSupportController.h>
#import <ZoomSDK/ZoomSDKMeetingAICompanionController.h>
#import <ZoomSDK/ZoomSDKCameraControlHelper.h>
#import <ZoomSDK/ZoomSDKMeetingIndicatorController.h>
#import <ZoomSDK/ZoomSDKMeetingProductionStudioController.h>
#import <ZoomSDK/ZoomSDKMeetingDocsController.h>
 
NS_ASSUME_NONNULL_BEGIN
 
@interface ZoomSDKMeetingParameter : NSObject
@property (assign,nonatomic) MeetingType meetingType;
@property (assign,nonatomic) BOOL isViewOnly;
@property (assign,nonatomic) BOOL isAutoRecordingLocal;
@property (assign,nonatomic) BOOL isAutoRecordingCloud;
@property (assign,nonatomic) long long meetingNumber;
@property (copy,nonatomic, nullable) NSString *meetingTopic;
@property (copy,nonatomic, nullable) NSString *meetingHost;
@end
 
 
@interface ZoomSDKStartMeetingElements : NSObject
@property(nonatomic, copy, nullable)NSString* vanityID;
@property(nonatomic, assign)ZoomSDKUserType userType;
@property(nonatomic, assign)long long meetingNumber;
@property(nonatomic, assign)BOOL isDirectShare;
@property(nonatomic, assign)CGDirectDisplayID displayID;
@property(nonatomic, assign)BOOL isNoVideo;
@property(nonatomic, assign)BOOL isNoAudio;
@property(nonatomic, copy, nullable)NSString* customerKey;
@property(nonatomic, assign)BOOL isMyVoiceInMix;
@property(nonatomic, copy, nullable)NSString *inviteContactID;
@property(nonatomic, assign)BOOL isAudioRawDataStereo;
@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
 
@end
 
 
@interface ZoomSDKStartMeetingUseZakElements : NSObject
@property(nonatomic, copy, nullable)NSString* zak;
@property(nonatomic, copy, nullable)NSString* displayName;
@property(nonatomic, copy, nullable)NSString* vanityID;
@property(nonatomic, assign)SDKUserType userType;
@property(nonatomic, assign)long long meetingNumber;
@property(nonatomic, assign)BOOL isDirectShare;
@property(nonatomic, assign)CGDirectDisplayID displayID;
@property(nonatomic, assign)BOOL isNoVideo;
@property(nonatomic, assign)BOOL isNoAudio;
@property(nonatomic, copy, nullable)NSString* customerKey;
@property(nonatomic, assign)BOOL isMyVoiceInMix;
@property(nonatomic, copy, nullable)NSString *inviteContactID;
@property(nonatomic, assign)BOOL isAudioRawDataStereo;
@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
 
@end
 
@interface ZoomSDKJoinMeetingElements : NSObject
@property(nonatomic, copy, nullable)NSString* zak;
@property(nonatomic, copy, nullable)NSString* webinarToken;
@property(nonatomic, copy, nullable)NSString* displayName;
@property(nonatomic, copy, nullable)NSString* vanityID;
@property(nonatomic, assign)ZoomSDKUserType userType;
@property(nonatomic, copy, nullable)NSString* customerKey;
@property(nonatomic, assign)long long meetingNumber;
@property(nonatomic, assign)BOOL isDirectShare;
@property(nonatomic, assign)CGDirectDisplayID displayID;
@property(nonatomic, assign)BOOL isNoVideo;
@property(nonatomic, assign)BOOL isNoAudio;
@property(nonatomic, copy, nullable)NSString *password;
@property(nonatomic, copy, nullable)NSString *appPrivilegeToken;
@property(nonatomic, copy, nullable)NSString *join_token;
@property(nonatomic, assign)BOOL isMyVoiceInMix;
@property(nonatomic, assign)BOOL isAudioRawDataStereo;
@property(nonatomic, assign)ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate;
@property(nonatomic, copy, nullable)NSString* onBehalfToken;
@property (assign,nonatomic)ZoomSDKVideoRawdataColorspace videoRawdataColorspace;
 
@end
 
 
@interface ZoomSDKMeetingInputUserInfoHandler : NSObject
 
@property(nonatomic, copy, readonly, nullable)NSString *defaultDisplayName;
 
@property(nonatomic, assign, readonly)BOOL canModifyDefaultDisplayName;
 
- (BOOL)isValidEmail:(NSString *)email;
 
- (ZoomSDKError)inputUserInfo:(NSString *)name email:(NSString *)email;
 
- (void)cancel;
@end
 
@interface ZoomSDKMeetingArchiveConfirmHandler : NSObject
@property(nonatomic, copy, readonly, nullable)NSString* archiveConfirmContent;
 
- (ZoomSDKError)joinWithArchive:(BOOL)startArchive;
@end
 
@interface ZoomSDKRecoverMeetingHandler : NSObject
@property(nonatomic, copy, readonly, nullable)NSString* recoverMeetingContent;
 
- (ZoomSDKError)recoverMeeting:(BOOL)toRecover;
@end
 
 
@interface ZoomSDKMeetingAppsignalHandler : NSObject
- (BOOL)canShowPanel;
 
- (ZoomSDKError)showPanel:(NSPoint)point parentWindow:(NSWindow*)parentWindow;
 
- (ZoomSDKError)hidePanel;
@end
 
 
 
@protocol ZoomSDKMeetingServiceDelegate <NSObject>
 
@optional
 
- (void)onMeetingStatusChange:(ZoomSDKMeetingStatus)state meetingError:(ZoomSDKMeetingError)error EndReason:(EndMeetingReason)reason;
 
- (void)onMeetingStatisticWarning:(StatisticWarningType)type;
 
- (void)onFreeMeetingNeedToUpgrade:(FreeMeetingNeedUpgradeType)type giftUpgradeURL:(NSString*_Nullable)giftURL;
 
- (void)onFreeMeetingUpgradeToGiftFreeTrialStart;
 
- (void)onFreeMeetingUpgradeToGiftFreeTrialStop;
 
- (void)onFreeMeetingUpgradedToProMeeting;
 
- (void)onFreeMeetingRemainTimeStopCountDown;
 
- (void)onFreeMeetingRemainTime:(unsigned int)seconds;
- (void)onMeetingParameterNotification:(ZoomSDKMeetingParameter *_Nullable)meetingParameter;
 
- (void)onJoinMeetingNeedUserInfo:(ZoomSDKMeetingInputUserInfoHandler *_Nullable)handler;
 
- (void)onUserConfirmToStartArchive:(ZoomSDKMeetingArchiveConfirmHandler *_Nullable)handler;
 
- (void)onEndOtherMeetingToJoinMeetingNotification:(ZoomSDKError (^)(void))actionEndOtherMeeting actionCancel:(void (^)(void))actionCancel;
 
- (void)onMeetingFullToWatchLiveStream:(NSString*)liveStreamUrl;
 
- (void)onUserConfirmRecoverMeeting:(ZoomSDKRecoverMeetingHandler * _Nullable)handler;
 
- (void)onUserNetworkStatusChanged:(ConnectionComponent)type level:(ZoomSDKConnectionQuality)level userID:(unsigned int)userID uplink:(BOOL)uplink;
- (void)onAppSignalPanelUpdated:(ZoomSDKMeetingAppsignalHandler * _Nullable)handler;
@end
 
@interface ZoomSDKMeetingService : NSObject
{
    id<ZoomSDKMeetingServiceDelegate> _delegate;
    ZoomSDKMeetingUIController* _meetingUIController;
    ZoomSDKMeetingConfiguration* _meetingConfiguration;
    ZoomSDKH323Helper*           _h323Helper;
    ZoomSDKWaitingRoomController* _waitingRoomController;
    ZoomSDKPhoneHelper*           _phoneHelper;
    ZoomSDKASController*          _asController;
    ZoomSDKMeetingActionController*  _actionController;
    ZoomSDKLiveStreamHelper*         _liveStreamHelper;
    //customized UI
    ZoomSDKVideoContainer*           _videoContainer;
    ZoomSDKMeetingRecordController*  _recordController;
    ZoomSDKWebinarController*        _webinarController;
    ZoomSDKCloseCaptionController*   _closeCaptionController;
    ZoomSDKRealNameAuthenticationController*       _realNameController;
    ZoomSDKQAController*             _QAController;
    ZoomSDKNewBreakoutRoomController*  _newBOController;
    ZoomSDKInterpretationController *  _InterpretationController;
    ZoomSDKReactionController*         _reactionController;
    ZoomSDKAppSignalController*        _appSignalController;
    ZoomSDKRawArchivingController*     _rawArchivingController;
    ZoomSDKSignInterpretationController*     _signInterpretationController;
    ZoomSDKCustomImmersiveController* _customImmersiveController;
    ZoomSDKMeetingChatController* _chatController;
    ZoomSDKMeetingWhiteboardController* _whiteboardController;
    ZoomSDKMeetingEncryptionController* _encryptionController;
    ZoomSDKPollingController*   _pollingController;
    ZoomSDKMeetingRemoteSupportController* _remoteSupportController;
    ZoomSDKMeetingAICompanionController* _AICompanionController;
    ZoomSDKMeetingIndicatorController * _meetingIndicatorController;
    ZoomSDKMeetingProductionStudioController* _productionStudioController;
    ZoomSDKMeetingDocsController * _meetingDocsController;
}
@property (assign, nonatomic, nullable) id<ZoomSDKMeetingServiceDelegate> delegate;
 
- (ZoomSDKMeetingUIController*)getMeetingUIController;
 
- (ZoomSDKMeetingConfiguration*)getMeetingConfiguration;
 
- (ZoomSDKH323Helper*_Nullable)getH323Helper;
 
- (ZoomSDKWaitingRoomController*)getWaitingRoomController;
 
- (ZoomSDKASController*)getASController;
 
- (ZoomSDKPhoneHelper*)getPhoneHelper;
 
- (ZoomSDKMeetingActionController*)getMeetingActionController;
 
- (ZoomSDKLiveStreamHelper*)getLiveStreamHelper;
 
- (ZoomSDKVideoContainer*_Nullable)getVideoContainer;
 
- (ZoomSDKMeetingRecordController*)getRecordController;
- (ZoomSDKWebinarController*)getWebinarController;
 
- (ZoomSDKCloseCaptionController*)getCloseCaptionController;
 
- (ZoomSDKRealNameAuthenticationController *)getRealNameController;
 
- (ZoomSDKQAController *)getQAController;
 
- (ZoomSDKNewBreakoutRoomController *)getNewBreakoutRoomController;
 
- (ZoomSDKInterpretationController*)getInterpretationController;
 
- (ZoomSDKSignInterpretationController*)getSignInterpretationController;
- (ZoomSDKReactionController*)getReactionController;
 
- (ZoomSDKAppSignalController*_Nullable)getAppSignalController;
 
- (ZoomSDKRawArchivingController*)getRawArchivingController;
 
 
- (ZoomSDKCustomImmersiveController*_Nullable)getMeetingImmersiveController;
 
- (ZoomSDKMeetingWhiteboardController*)getMeetingWhiteboardController;
- (ZoomSDKMeetingChatController*)getMeetingChatController;
 
- (ZoomSDKMeetingEncryptionController*)getInMeetingEncryptionController;
 
- (ZoomSDKMeetingRemoteSupportController*)getMeetingRemoteSupportController;
 
- (NSString*)getInMeetingDataCenterInfo;
 
- (ZoomSDKPollingController*)getMeetingPollingController;
 
- (ZoomSDKMeetingAICompanionController*)getInMeetingAICompanionController;
 
- (ZoomSDKCameraControlHelper*_Nullable)getCameraControlHelper:(unsigned int)userId;
 
- (ZoomSDKMeetingProductionStudioController*)getMeetingProductionStudioController;
 
- (ZoomSDKError)revokeCameraControlPrivilege;
 
- (ZoomSDKMeetingIndicatorController*_Nullable)getMeetingIndicatorController;
 
- (ZoomSDKMeetingDocsController*_Nullable)getMeetingDocsController;
 
- (ZoomSDKError)startMeeting:(ZoomSDKStartMeetingElements *)context;
- (ZoomSDKError)startMeetingWithZAK:(ZoomSDKStartMeetingUseZakElements *)context;
- (ZoomSDKError)joinMeeting:(ZoomSDKJoinMeetingElements *)context;
- (void)leaveMeetingWithCmd:(LeaveMeetingCmd)cmd;
 
- (ZoomSDKMeetingStatus)getMeetingStatus;
 
- (NSString*_Nullable)getMeetingProperty:(MeetingPropertyCmd)command;
 
- (int)getSupportedMeetingAudioType;
 
- (ZoomSDKConnectionQuality)getConnectionQuality:(ConnectionComponent)component Sending:(BOOL)sending;
- (MeetingType)getMeetingType;
 
- (BOOL)isFailoverMeeting;
 
- (ZoomSDKError)handleZoomWebUrlAction:(NSString*)urlAction;
 
- (CGSize)getUserVideoSize:(unsigned int)userID;
@end
NS_ASSUME_NONNULL_END