ZoomVideoSDKDelegate.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoRawData.h>
#import <ZoomVideoSDK/ZoomVideoSDKAudioRawData.h>
#import <ZoomVideoSDK/ZoomVideoSDKChatHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKPreProcessRawData.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoSender.h>
#import <ZoomVideoSDK/ZoomVideoSDKShareSender.h>
#import <ZoomVideoSDK/ZoomVideoSDKShareAudioSender.h>
#import <ZoomVideoSDK/ZoomVideoSDKAudioSender.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoCapability.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKAudioHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKRecordingHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKLiveStreamHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKUserHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKLiveTranscriptionHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKFileTranserHandle.h>
#import <ZoomVideoSDK/ZoomVideoSDKSubSessionHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKWhiteboardHelper.h>
#import <ReplayKit/ReplayKit.h>
@class ZoomVideoSDKRawDataPipe;
@class ZoomVideoSDKVideoCanvas;
@class ZoomVideoSDKUser;
@class ZoomVideoSDKProxySettingHandler;
@class ZoomVideoSDKSSLCertificateInfo;
@class ZoomVideoSDKSubSessionUserHelpRequestHandler;
@class ZoomVideoSDKQOSStatistics;
@class ZoomVideoSDKQOSSendStatistics;
@class ZoomVideoSDKQOSRecvStatistics;

@protocol ZoomVideoSDKDelegate <NSObject>
@optional
- (void)onSessionJoin;

- (void)onSessionLeave DEPRECATED_MSG_ATTRIBUTE("use onSessionLeave: instead");

- (void)onSessionLeave:(ZoomVideoSDKSessionLeaveReason)reason;

- (void)onError:(ZoomVideoSDKError)ErrorType detail:(NSInteger)details;

- (void)onAudioError:(ZoomVideoSDKAudioHelper * _Nullable)helper errorType:(ZoomVideoSDKAudioErrorType)errorType detail:(NSInteger)detail;

- (void)onUserJoin:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;

- (void)onUserLeave:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;

- (void)onUserVideoStatusChanged:(ZoomVideoSDKVideoHelper * _Nullable)helper user:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;

- (void)onUserAudioStatusChanged:(ZoomVideoSDKAudioHelper * _Nullable)helper user:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;

- (void)onUserShareStatusChanged:(ZoomVideoSDKShareHelper * _Nullable)helper user:(ZoomVideoSDKUser * _Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;

- (void)onFailedToStartShare:(ZoomVideoSDKShareHelper* _Nonnull)helper user:(ZoomVideoSDKUser* _Nullable)user;

- (void)onShareSettingChanged:(ZoomVideoSDKShareSetting)setting;

- (void)onLiveStreamStatusChanged:(ZoomVideoSDKLiveStreamHelper * _Nullable)helper status:(ZoomVideoSDKLiveStreamStatus)status;

- (void)onChatPrivilegeChanged:(ZoomVideoSDKChatHelper * _Nullable)helper privilege:(ZoomVideoSDKChatPrivilegeType)currentPrivilege;

- (void)onChatNewMessageNotify:(ZoomVideoSDKChatHelper * _Nullable)helper message:(ZoomVideoSDKChatMessage * _Nullable)chatMessage;

- (void)onChatMsgDeleteNotification:(ZoomVideoSDKChatHelper * _Nullable)helper messageID:(NSString * _Nonnull)msgID deleteBy:(ZoomVideoSDKChatMsgDeleteBy)type;

- (void)onUserHostChanged:(ZoomVideoSDKUserHelper * _Nullable)helper users:(ZoomVideoSDKUser * _Nullable)user;

- (void)onUserManagerChanged:(ZoomVideoSDKUser * _Nullable)user;

- (void)onUserNameChanged:(ZoomVideoSDKUser * _Nullable)user;

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

- (void)onUserActiveAudioChanged:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;

- (void)onSessionNeedPassword:(ZoomVideoSDKError (^ _Nullable)(NSString * _Nullable password, BOOL leaveSessionIgnorePassword))completion;

- (void)onSessionPasswordWrong:(ZoomVideoSDKError (^ _Nullable)(NSString * _Nullable password, BOOL leaveSessionIgnorePassword))completion;

- (void)onMixedAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;

- (void)onOneWayAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData user:(ZoomVideoSDKUser * _Nullable)user;

- (void)onSharedAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;

- (void)onInviteByPhoneStatus:(ZoomVideoSDKPhoneStatus)status failReason:(ZoomVideoSDKPhoneFailedReason)failReason;

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

- (void)onCmdChannelConnectResult:(BOOL)success;

- (void)onCommandReceived:(NSString * _Nullable)commandContent sendUser:(ZoomVideoSDKUser * _Nullable)sendUser;

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

- (void)onCloudRecordingStatus:(ZoomVideoSDKRecordingStatus)status recordAgreementHandler:(ZoomVideoSDKRecordAgreementHandler * _Nullable)handler;

- (void)onUserRecordAgreementNotification:(ZoomVideoSDKUser * _Nullable)user;

- (void)onHostAskUnmute;

- (void)onMultiCameraStreamStatusChanged:(ZoomVideoSDKMultiCameraStreamStatus)status parentUser:(ZoomVideoSDKUser *_Nullable)user videoPipe:(ZoomVideoSDKRawDataPipe *_Nullable)videoPipe;

- (void)onMultiCameraStreamStatusChanged:(ZoomVideoSDKMultiCameraStreamStatus)status parentUser:(ZoomVideoSDKUser *_Nullable)user videoCanvas:(ZoomVideoSDKVideoCanvas *_Nullable)videoCanvas;

- (void)onTestMicStatusChanged:(ZoomVideoSDKTestMicStatus)status;

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

- (void)onAudioLevelChanged:(NSUInteger)level audioSharing:(BOOL)bAudioSharing user:(ZoomVideoSDKUser * _Nullable)user;

- (void)onSystemPermissionRequired:(ZoomVideoSDKSystemPermissionType)permissionType;

- (void)onLiveTranscriptionStatus:(ZoomVideoSDKLiveTranscriptionStatus)status;

- (void)onLiveTranscriptionMsgReceived:(ZoomVideoSDKLiveTranscriptionMessageInfo *_Nullable)messageInfo;

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

- (void)onLiveTranscriptionMsgError:(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)spokenLanguage transLanguage:(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)transcriptLanguage;

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

- (void)onVoiceInterpretationReady;

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

- (void)onSSLCertVerifiedFailNotification:(ZoomVideoSDKSSLCertificateInfo *_Nonnull)handler;
 

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

- (void)onUserShareNetworkStatusChanged:(ZoomVideoSDKNetworkStatus)shareNetworkStatus isSending:(BOOL)isSendingShare DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");

- (void)onUserNetworkStatusChanged:(ZoomVideoSDKDataType)type level:(ZoomVideoSDKNetworkStatus)level user:(ZoomVideoSDKUser * _Nullable)user;

- (void)onUserOverallNetworkStatusChanged:(ZoomVideoSDKNetworkStatus)level user:(ZoomVideoSDKUser * _Nullable)user;
 

- (void)onCallCRCDeviceStatusChanged:(ZoomVideoSDKCRCCallStatus)state;

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

- (void)onAnnotationPrivilegeChange:(BOOL)enable shareOwner:(ZoomVideoSDKUser *_Nullable)user DEPRECATED_MSG_ATTRIBUTE("use -[ZoomVideoSDKDelegate onAnnotationPrivilegeChangeWithUser:shareAction:] instead");

- (void)onAnnotationPrivilegeChangeWithUser:(ZoomVideoSDKUser *_Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;

- (void)onAnnotationToolTypeChanged:(ZoomVideoSDKAnnotationHelper *_Nullable)helper view:(UIView *_Nullable)view toolType:(ZoomVideoSDKAnnotationToolType)toolType;
- (void)onShareContentChanged:(ZoomVideoSDKShareHelper *_Nullable)shareHelper user:(ZoomVideoSDKUser *_Nullable)user shareAction:(ZoomVideoSDKShareAction *_Nullable)shareAction;

- (void)onShareCaptureSizeChanged:(ZoomVideoSDKShareHelper *_Nullable)shareHelper user:(ZoomVideoSDKUser *_Nullable)user shareAction:(ZoomVideoSDKShareAction *_Nullable)shareAction;

- (void)onVideoCanvasSubscribeFail:(ZoomVideoSDKSubscribeFailReason)failReason user:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view;

- (void)onShareCanvasSubscribeFail:(ZoomVideoSDKSubscribeFailReason)failReason user:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view DEPRECATED_MSG_ATTRIBUTE("use -[ZoomVideoSDKDelegate onShareCanvasSubscribeFailWithUser:view:shareAction:] instead");

- (void)onShareCanvasSubscribeFailWithUser:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;

- (void)onSendFileStatus:(ZoomVideoSDKSendFile * _Nullable)file status:(ZoomVideoSDKFileTransferStatus)status;

- (void)onReceiveFileStatus:(ZoomVideoSDKReceiveFile * _Nullable)file status:(ZoomVideoSDKFileTransferStatus)status;

- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaChannelOn;

- (void)onSpotlightVideoChanged:(ZoomVideoSDKVideoHelper * _Nullable)videoHelper userList:(NSArray <ZoomVideoSDKUser *>* _Nullable)userList;

- (void)onBindIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;

- (void)onUnbindIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;

- (void)onIncomingLiveStreamStatusResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamsStatusList:(NSArray<ZoomVideoSDKIncomingLiveStreamStatus *> *_Nullable)streamsStatusList;

- (void)onStartIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;

- (void)onStopIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;

- (void)onShareContentSizeChanged:(ZoomVideoSDKShareHelper * _Nullable)helper user:(ZoomVideoSDKUser * _Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;
 
#pragma mark - external camera change -
- (void)onUVCCameraStatusChange:(ZoomVideoSDKUVCCameraStatus)status;
 
#pragma mark - sub-session -
- (void)onSubSessionStatusChanged:(ZoomVideoSDKSubSessionStatus)status subSession:(NSArray <ZoomVideoSDKSubSessionKit*>* _Nonnull)pSubSessionKitList;

- (void)onSubSessionManagerHandle:(ZoomVideoSDKSubSessionManager* _Nullable)pManager;

- (void)onSubSessionParticipantHandle:(ZoomVideoSDKSubSessionParticipant* _Nullable)pParticipant;

- (void)onSubSessionUsersUpdate:(ZoomVideoSDKSubSessionKit* _Nonnull)pSubSessionKit;

- (void)onBroadcastMessageFromMainSession:(NSString* _Nonnull) sMessage userName:(NSString* _Nonnull)sUserName;

- (void)onSubSessionUserHelpRequestHandler:(ZoomVideoSDKSubSessionUserHelpRequestHandler*_Nonnull) pHandler;

- (void)onSubSessionUserHelpRequestResult:(ZoomVideoSDKUserHelpRequestResult)result;
 
#pragma mark - ZoomVideoSDK audio source change -
- (void)onMyAudioSourceTypeChanged:(ZoomVideoSDKAudioDevice *_Nullable)device;
 
#pragma mark - In app screen share -
- (void)onInAppScreenShareErrorCode:(RPRecordingErrorCode)code;

- (void)onInAppScreenShareAvailableChanged:(BOOL)available;

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

- (void)onStopBroadcastResponse:(BOOL)isSuccess;

- (void)onGetBroadcastControlStatus:(BOOL)isSuccess status:(ZoomVideoSDKBroadcastControlStatus)status;

- (void)onStreamingJoinStatusChanged:(ZoomVideoSDKStreamingJoinStatus)status ;

- (void)onEmojiReactionReceived:(ZoomVideoSDKUser * _Nullable)user type:(ZoomVideoSDKEmojiReactionType)type;

- (void)onWhiteboardExported:(ZoomVideoSDKWhiteboardExportFormatType)format data:(NSData*_Nonnull)data  API_UNAVAILABLE(visionos);

-(void)onUserWhiteboardShareStatusChanged:(ZoomVideoSDKUser *_Nonnull)user whiteboardhelper:(ZoomVideoSDKWhiteboardHelper*_Nonnull)whiteboardHelper  API_UNAVAILABLE(visionos);

-(void)onCanvasSnapshotTaken:(ZoomVideoSDKUser *_Nonnull)user isShare:(BOOL)isShare;

-(void)onCanvasSnapshotIncompatible:(ZoomVideoSDKUser *_Nonnull)user;

- (void)onRealTimeMediaStreamsStatus:(ZoomVideoSDKRealTimeMediaStreamsStatus)status;

- (void)onRealTimeMediaStreamsFail:(ZoomVideoSDKRealTimeMediaStreamsFailReason)failReason;

- (void)onQOSStatisticsReceived:(ZoomVideoSDKQOSStatistics * _Nonnull)statistics user:(ZoomVideoSDKUser * _Nullable)user;
 
@end
 
#pragma mark - ZoomVideoSDKVirtualAudioSpeaker
@protocol ZoomVideoSDKVirtualAudioSpeaker <NSObject>
 
@optional

- (void)onVirtualSpeakerMixedAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;

- (void)onVirtualSpeakerOneWayAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData user:(ZoomVideoSDKUser * _Nullable)user;

- (void)onVirtualSpeakerSharedAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
 
@end
 
#pragma mark - ZoomVideoSDKRawDataPipeDelegate
@protocol ZoomVideoSDKRawDataPipeDelegate <NSObject>
 
@optional

- (void)onPixelBuffer:(CVPixelBufferRef _Nullable )pixelBuffer
             rotation:(ZoomVideoSDKVideoRawDataRotation)rotation;

- (void)onRawDataFrameReceived:(ZoomVideoSDKVideoRawData * _Nullable)rawData;

- (void)onRawDataStatusChanged:(ZoomVideoSDKUserRawdataStatus)userRawdataStatus;
 
@end
 
#pragma mark - ZoomVideoSDKVideoSourcePreProcessor
@protocol ZoomVideoSDKVideoSourcePreProcessor <NSObject>
 
@optional
- (void)onPreProcessRawData:(ZoomVideoSDKPreProcessRawData * _Nullable)rawData;
 
@end
 
#pragma mark - ZoomVideoSDKVideoSource
@protocol ZoomVideoSDKVideoSource <NSObject>
 
@optional

- (void)onInitialize:(ZoomVideoSDKVideoSender *_Nonnull)rawDataSender
supportCapabilityArray:(NSArray *_Nonnull)supportCapabilityArray
   suggestCapability:(ZoomVideoSDKVideoCapability *_Nonnull)suggestCapability;

- (void)onPropertyChange:(NSArray *_Nonnull)supportCapabilityArray
       suggestCapability:(ZoomVideoSDKVideoCapability *_Nonnull)suggestCapability;

- (void)onStartSend;

- (void)onStopSend;

- (void)onUninitialized;
 
@end

@protocol ZoomVideoSDKVirtualAudioMic <NSObject>
 
@optional
- (void)onMicInitialize:(ZoomVideoSDKAudioSender *_Nonnull)rawDataSender;

- (void)onMicStartSend;

- (void)onMicStopSend;

- (void)onMicUninitialized;
 
@end
 
#pragma mark - ZoomVideoSDKShareSource
@protocol ZoomVideoSDKShareSource <NSObject>
 
@optional
- (void)onShareSendStarted:(ZoomVideoSDKShareSender *_Nullable)rawDataSender;

- (void)onShareSendStopped;
 
@end
 
#pragma mark - ZoomVideoSDKShareAudioSource
@protocol ZoomVideoSDKShareAudioSource <NSObject>
 
@optional
- (void)onStartSendAudio:(ZoomVideoSDKShareAudioSender *_Nonnull)sender;

- (void)onStopSendAudio;
 
@end
 
#pragma mark - ZoomVideoSDKSharePreprocessor
@protocol ZoomVideoSDKSharePreprocessor <NSObject>
 
@optional
- (void)onCapturedRawDataReceived:(ZoomVideoSDKVideoRawData *_Nullable)rawData sharePreprocessSender:(ZoomVideoSDKSharePreprocessSender *_Nullable)sender;

- (void)onShareStopped;
 
@end
 
 
 
@protocol ZoomVideoSDKBroadcastStreamingVideoDelegate <NSObject>
@optional
- (void)onVideoFrameRecieved:(ZoomVideoSDKVideoRawData * _Nullable)rawData;

- (void)onPixelBuffer:(CVPixelBufferRef _Nullable )pixelBuffer  rotation:(ZoomVideoSDKVideoRawDataRotation)rotation;
@end
 
@protocol ZoomVideoSDKBroadcastStreamingAudioDelegate <NSObject>
@optional
- (void)onAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
@end