ZMVideoSDKDelegate.h

Go to the documentation of this file.

 
#import <AppKit/AppKit.h>
#import <ZMVideoSDK/ZMVideoSDKDef.h>
 
NS_ASSUME_NONNULL_BEGIN
@class ZMVideoSDKUserHelper;
@class ZMVideoSDKVideoHelper;
@class ZMVideoSDKAudioHelper;
@class ZMVideoSDKShareHelper;
@class ZMVideoSDKLiveStreamHelper;
@class ZMVideoSDKChatHelper;
@class ZMVideoSDKAudioRawData;
@class ZMVideoSDKUser;
@class ZMVideoSDKChatMessage;
@class ZMVideoSDKPasswordHandler;
@class ZMVideoSDKCameraControlRequestHandler;
@class ZMVideoSDKRawDataPipe;
@class ZMVideoSDKLiveTranscriptionLanguage;
@class ZMVideoSDKSSLCertificateInfo;
@class ZMVideoSDKProxySettingHandler;
@class ZMVideoSDKRecordingConsentHandler;
@class ZMVideoSDKLiveTranscriptionMessageInfo;
@class ZMVideoSDKAnnotationHelper;
@class ZMVideoSDKVideoCanvas;
@class ZMVideoSDKSendFile;
@class ZMVideoSDKReceiveFile;
@class ZMVideoSDKRemoteControlRequestHandler;
@class ZMVideoSDKShareAction;
@class ZMVideoSDKSubSessionKit;
@class ZMVideoSDKSubSessionUser;
@class ZMVideoSDKSubSessionManager;
@class ZMVideoSDKSubSessionParticipant;
@class ZMVideoSDKSubSessionUserHelpRequestHandler;
@class ZMVideoSDKWhiteboardHelper;
@class ZMVideoSDKQOSStatistics;
@class ZMVideoSDKQOSSendStatistics;
@class ZMVideoSDKQOSRecvStatistics;
@protocol ZMVideoSDKDelegate <NSObject>
@optional
    
- (void)onSessionJoin;
    
- (void)onSessionLeave DEPRECATED_MSG_ATTRIBUTE("Use -onSessionLeave: instead");

- (void)onSessionLeave:(ZMVideoSDKSessionLeaveReason)reason;

- (void)onError:(ZMVideoSDKErrors)ErrorType detail:(int)details;
    
- (void)onUserJoin:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
    
- (void)onUserLeave:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
    
- (void)onUserVideoStatusChanged:(ZMVideoSDKVideoHelper* _Nonnull)videoHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
    
- (void)onUserAudioStatusChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
    
- (void)onUserShareStatusChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onShareContentSizeChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onShareContentChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onUnsharingWindowsChanged:(NSArray<NSNumber*>*)windowsList shareHelper:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onSharingProcessWindowsStateChanged:(BOOL)isAnyWindowSharing shareHelper:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onSharingActiveMonitorChanged:(NSArray<NSNumber*>*)monitorIDs shareHelper:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onFailedToStartShare:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user;

- (void)onShareSettingChanged:(ZMVideoSDKShareSetting)setting;

- (void)onLiveStreamStatusChanged:(ZMVideoSDKLiveStreamHelper* _Nonnull)liveStreamHelper liveStreamStatus:(ZMVideoSDKLiveStreamStatus)status;

- (void)onChatNewMessageNotify:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatMessage:(ZMVideoSDKChatMessage* _Nullable)chatMessage;
    
- (void)onUserHostChanged:(ZMVideoSDKUserHelper* _Nonnull)userHelper user:(ZMVideoSDKUser* _Nullable)user;
    
- (void)onUserActiveAudioChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
    
- (void)onSessionNeedPassword:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
    
- (void)onSessionPasswordWrong:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
    
- (void)onMixedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data;
    
- (void)onOneWayAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data user:(ZMVideoSDKUser* _Nullable)user;
    
- (void)onUserManagerChanged:(ZMVideoSDKUser* _Nullable)user;
    
- (void)onUserNameChanged:(ZMVideoSDKUser* _Nullable)user;

- (void)onUserFailoverStatusChanged:(ZMVideoSDKUser* _Nullable)user inFailover:(BOOL)inFailover;

- (void)onSharedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nullable)data;

- (void)onCloudRecordingStatus:(ZMRecordingStatus)status recordingConsentHandler:(ZMVideoSDKRecordingConsentHandler * _Nullable)handler;

- (void)onUserRecordingConsent:(ZMVideoSDKUser * _Nullable)user;
- (void)onCommandReceived:(NSString* _Nullable)commandContent senderUser:(ZMVideoSDKUser* _Nullable)user;

- (void)onCameraControlRequestResult:(ZMVideoSDKUser* _Nullable)user approved:(BOOL)isApproved;

- (void)onCameraControlRequestReceived:(ZMVideoSDKUser* _Nullable)user cameraControlRequestType:(ZMVideoSDKCameraControlRequestType)requestType requestHandler:(ZMVideoSDKCameraControlRequestHandler* _Nullable)cameraControlRequestHandler;

- (void)onCommandChannelConnectResult:(BOOL)isSuccess;

- (void)onHostAskUnmute;

- (void)onInviteByPhoneStatus:(ZMPhoneStatus)status reason:(ZMPhoneFailedReason)reason;

- (void)onCalloutJoinSuccess:(ZMVideoSDKUser * _Nullable)user phoneNumber:(NSString * _Nullable)phoneNumber;

- (void)onMultiCameraStreamStatusChanged:(ZMVideoSDKMultiCameraStreamStatus)status user:(ZMVideoSDKUser * _Nullable)user rawDataPipe:(ZMVideoSDKRawDataPipe * _Nullable)videoPipe;

- (void)onAudioLevelChanged:(unsigned int)level audioSharing:(BOOL)bAudioSharing user:(ZMVideoSDKUser * _Nullable)user;

- (void)onMicSpeakerVolumeChanged:(unsigned int)micVolume speakerVolume:(unsigned int)speakerVolume;

- (void)onAudioDeviceStatusChanged:(ZMVideoSDKAudioDeviceType)type status:(ZMVideoSDKAudioDeviceStatus)status;

- (void)onTestMicStatusChanged:(ZMVideoSDKMicTestStatus)status;

- (void)onSelectedAudioDeviceChanged;

- (void)onCameraListChanged;

- (void)onLiveTranscriptionStatus:(ZMVideoSDKLiveTranscriptionStatus)status;

- (void)onLiveTranscriptionMsgInfoReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;

- (void)onOriginalLanguageMsgReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;

- (void)onLiveTranscriptionMsgError:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage transcriptLanguage:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)transcriptLanguage;

- (void)onSpokenLanguageChanged:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage;

- (void)onVoiceInterpretationReady;

- (void)onChatMsgDeleteNotification:(ZMVideoSDKChatHelper* _Nonnull)chatHelper messageID:(NSString * _Nullable)msgID deleteBy:(ZMVideoSDKChatMessageDeleteType)type;

- (void)onChatPrivilegeChanged:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatPrivilegeType:(ZMVideoSDKChatPrivilegeType)privilege;

- (void)onProxyDetectComplete;

- (void)onProxySettingNotification:(ZMVideoSDKProxySettingHandler * _Nonnull)handler;

- (void)onSSLCertVerifiedFailNotification:(ZMVideoSDKSSLCertificateInfo * _Nonnull)info;

- (void)onUserVideoNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status user:(ZMVideoSDKUser * _Nullable)user DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");

- (void)onShareNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status isSendingShare:(BOOL)isSendingShare DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");

- (void)onUserNetworkStatusChanged:(ZMVideoSDKDataType)type level:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;

- (void)onUserOverallNetworkStatusChanged:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;

- (void)onQOSStatisticsReceived:(ZMVideoSDKQOSStatistics * _Nonnull)statistics user:(ZMVideoSDKUser * _Nullable)user;

- (void)onCallCRCDeviceStatusChanged:(ZMVideoSDKCRCCallStatus)status;

- (void)onVideoCanvasSubscribeFail:(ZMVideoSDKSubscribeFailReason)failReason user:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view;

- (void)onShareCanvasSubscribeFail:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view  shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onAnnotationHelperCleanUp:(ZMVideoSDKAnnotationHelper* _Nullable)helper;

- (void)onAnnotationPrivilegeChange:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onAnnotationHelperActived:(NSView* _Nullable)view;

- (void)onAnnotationToolTypeChanged:(ZMVideoSDKAnnotationHelper* _Nullable)helper view:(NSView* _Nullable)view toolType:(ZMVideoSDKAnnotationToolType)toolType;

- (void)onSendFile:(ZMVideoSDKSendFile * _Nullable)sendFile status:(ZMVideoSDKFileTransferStatus)status;

- (void)onReceiveFile:(ZMVideoSDKReceiveFile * _Nullable)receiveFile status:(ZMVideoSDKFileTransferStatus)status;

- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaModeOn;

- (void)onRemoteControlStatus:(ZMVideoSDKRemoteControlStatus)status user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;

- (void)onRemoteControlRequestReceived:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction handler:(ZMVideoSDKRemoteControlRequestHandler *)handler;

- (void)onSpotlightVideoChanged:(ZMVideoSDKVideoHelper*)videoHelper userList:(NSArray<ZMVideoSDKUser*>*_Nullable)userlist;

- (void)onBindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;

- (void)onUnbindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;

- (void)onIncomingLiveStreamStatusResponse:(BOOL)bSuccess streamsStatusList:(NSArray*)streamsStatusList;

- (void)onStartIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;

- (void)onStopIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;

- (void)onSubSessionStatusChanged:(ZMVideoSDKSubSessionStatus)status subSessionKit:(NSArray<ZMVideoSDKSubSessionKit*>* _Nullable)subSessionKitList;

- (void)onSubSessionManagerHandle:(ZMVideoSDKSubSessionManager* _Nullable)manager;

- (void)onSubSessionParticipantHandle:(ZMVideoSDKSubSessionParticipant* _Nullable)participant;

- (void)onSubSessionUsersUpdate:(ZMVideoSDKSubSessionKit* _Nullable)subSessionKit;

- (void)onBroadcastMessageFromMainSession:(NSString*)message userName:(NSString*)name;

- (void)onSubSessionUserHelpRequest:(ZMVideoSDKSubSessionUserHelpRequestHandler*)handler;

- (void)onSubSessionUserHelpRequestResult:(ZMVideoSDKUserHelpRequestResult)result;

- (void)onWhiteboardExported:(ZMVideoSDKExportFormat)format data:(unsigned char *)data dataLength:(long)length;
 
 

- (void)onUserWhiteboardShareStatusChanged:(ZMVideoSDKUser *)user whiteboardHelper:(ZMVideoSDKWhiteboardHelper *)whiteboardHelper;

- (void)onStartBroadcastResponse:(BOOL)isSuccess channelID:(NSString*)channelID;

- (void)onStopBroadcastResponse:(BOOL)isSuccess;

- (void)onGetBroadcastControlStatus:(BOOL)isSuccess broadcastControlStatus:(ZMVideoSDKBroadcastControlStatus)status;

- (void)onStreamingJoinStatusChanged:(ZMVideoSDKStreamingJoinStatus)status;

- (void)onEmojiReactionReceived:(ZMVideoSDKUser* _Nullable)user type:(ZMVideoSDKEmojiReactionType)type;

- (void)onRealTimeMediaStreamsStatusChanged:(ZMVideoSDKRealTimeMediaStreamsStatus)status;

- (void)onRealTimeMediaStreamsFail:(ZMVideoSDKRealTimeMediaStreamsFailReason)failReason;

- (void)onCanvasSnapshotTaken:(ZMVideoSDKUser *)user isShare:(BOOL)isShare;

- (void)onCanvasSnapshotIncompatible:(ZMVideoSDKUser *)user;
@end
NS_ASSUME_NONNULL_END