Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKDelegate.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKDelegate.h
3// ZoomVideoSDK
4//
5
6#import <Foundation/Foundation.h>
7#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
8#import <ZoomVideoSDK/ZoomVideoSDKVideoRawData.h>
9#import <ZoomVideoSDK/ZoomVideoSDKAudioRawData.h>
10#import <ZoomVideoSDK/ZoomVideoSDKChatHelper.h>
11#import <ZoomVideoSDK/ZoomVideoSDKPreProcessRawData.h>
12#import <ZoomVideoSDK/ZoomVideoSDKVideoSender.h>
13#import <ZoomVideoSDK/ZoomVideoSDKShareSender.h>
14#import <ZoomVideoSDK/ZoomVideoSDKShareAudioSender.h>
15#import <ZoomVideoSDK/ZoomVideoSDKAudioSender.h>
16#import <ZoomVideoSDK/ZoomVideoSDKVideoCapability.h>
17#import <ZoomVideoSDK/ZoomVideoSDKVideoHelper.h>
18#import <ZoomVideoSDK/ZoomVideoSDKAudioHelper.h>
19#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
20#import <ZoomVideoSDK/ZoomVideoSDKRecordingHelper.h>
21#import <ZoomVideoSDK/ZoomVideoSDKLiveStreamHelper.h>
22#import <ZoomVideoSDK/ZoomVideoSDKUserHelper.h>
23#import <ZoomVideoSDK/ZoomVideoSDKLiveTranscriptionHelper.h>
24#import <ZoomVideoSDK/ZoomVideoSDKFileTranserHandle.h>
25
28@class ZoomVideoSDKUser;
31
35@protocol ZoomVideoSDKDelegate <NSObject>
36@optional
40- (void)onSessionJoin;
41
45- (void)onSessionLeave DEPRECATED_MSG_ATTRIBUTE("use onSessionLeave: instead");
46
51- (void)onSessionLeave:(ZoomVideoSDKSessionLeaveReason)reason;
52
58- (void)onError:(ZoomVideoSDKError)ErrorType detail:(NSInteger)details;
59
65- (void)onUserJoin:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;
66
72- (void)onUserLeave:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;
73
79- (void)onUserVideoStatusChanged:(ZoomVideoSDKVideoHelper * _Nullable)helper user:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;
80
86- (void)onUserAudioStatusChanged:(ZoomVideoSDKAudioHelper * _Nullable)helper user:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;
87
94- (void)onUserShareStatusChanged:(ZoomVideoSDKShareHelper * _Nullable)helper user:(ZoomVideoSDKUser * _Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;
95
101- (void)onFailedToStartShare:(ZoomVideoSDKShareHelper* _Nonnull)helper user:(ZoomVideoSDKUser* _Nullable)user;
107- (void)onLiveStreamStatusChanged:(ZoomVideoSDKLiveStreamHelper * _Nullable)helper status:(ZoomVideoSDKLiveStreamStatus)status;
108
114- (void)onChatPrivilegeChanged:(ZoomVideoSDKChatHelper * _Nullable)helper privilege:(ZoomVideoSDKChatPrivilegeType)currentPrivilege;
115
121- (void)onChatNewMessageNotify:(ZoomVideoSDKChatHelper * _Nullable)helper message:(ZoomVideoSDKChatMessage * _Nullable)chatMessage;
122
129- (void)onChatMsgDeleteNotification:(ZoomVideoSDKChatHelper * _Nullable)helper messageID:(NSString * __nonnull)msgID deleteBy:(ZoomVideoSDKChatMsgDeleteBy) type;
130
136- (void)onUserHostChanged:(ZoomVideoSDKUserHelper * _Nullable)helper users:(ZoomVideoSDKUser * _Nullable)user;
137
142- (void)onUserManagerChanged:(ZoomVideoSDKUser * _Nullable)user;
143
148- (void)onUserNameChanged:(ZoomVideoSDKUser * _Nullable)user;
149
155- (void)onUserActiveAudioChanged:(ZoomVideoSDKUserHelper * _Nullable)helper users:(NSArray <ZoomVideoSDKUser *>* _Nullable)userArray;
156
161- (void)onSessionNeedPassword:(ZoomVideoSDKError (^ _Nullable)(NSString * _Nullable password, BOOL leaveSessionIgnorePassword))completion;
162
167- (void)onSessionPasswordWrong:(ZoomVideoSDKError (^ _Nullable)(NSString * _Nullable password, BOOL leaveSessionIgnorePassword))completion;
168
173- (void)onMixedAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
174
180- (void)onOneWayAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData user:(ZoomVideoSDKUser * _Nullable)user;
181
186- (void)onSharedAudioRawDataReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
187
193- (void)onInviteByPhoneStatus:(ZoomVideoSDKPhoneStatus)status failReason:(ZoomVideoSDKPhoneFailedReason)failReason;
194
200- (void)onCalloutJoinSuccess:(ZoomVideoSDKUser * _Nullable)user phoneNumber:(NSString * _Nullable)phoneNumber;
201
207- (void)onCmdChannelConnectResult:(BOOL)success;
208
214- (void)onCommandReceived:(NSString * _Nullable)commandContent sendUser:(ZoomVideoSDKUser * _Nullable)sendUser;
215
222- (void)onCameraControlRequestResult:(ZoomVideoSDKUser* _Nullable)user approved:(BOOL)isApproved;
223
229- (void)onCloudRecordingStatus:(ZoomVideoSDKRecordingStatus)status recordAgreementHandler:(ZoomVideoSDKRecordAgreementHandler * _Nullable)handler;
230
235- (void)onUserRecordAgreementNotification:(ZoomVideoSDKUser * _Nullable)user;
239- (void)onHostAskUnmute;
240
247- (void)onMultiCameraStreamStatusChanged:(ZoomVideoSDKMultiCameraStreamStatus)status parentUser:(ZoomVideoSDKUser *_Nullable)user videoPipe:(ZoomVideoSDKRawDataPipe *_Nullable)videoPipe;
248
255- (void)onMultiCameraStreamStatusChanged:(ZoomVideoSDKMultiCameraStreamStatus)status parentUser:(ZoomVideoSDKUser *_Nullable)user videoCanvas:(ZoomVideoSDKVideoCanvas *_Nullable)videoCanvas;
256
261- (void)onTestMicStatusChanged:(ZoomVideoSDKTestMicStatus)status;
262
268- (void)onMicSpeakerVolumeChanged:(int)micVolume speakerVolume:(int)speakerVolume;
269
274- (void)onSystemPermissionRequired:(ZoomVideoSDKSystemPermissionType)permissionType;
275
280- (void)onLiveTranscriptionStatus:(ZoomVideoSDKLiveTranscriptionStatus)status;
281
286- (void)onLiveTranscriptionMsgReceived:(ZoomVideoSDKLiveTranscriptionMessageInfo *_Nullable)messageInfo;
287
292- (void)onOriginalLanguageMsgReceived:(ZoomVideoSDKLiveTranscriptionMessageInfo *_Nullable)messageInfo;
293
299- (void)onLiveTranscriptionMsgError:(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)spokenLanguage transLanguage:(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)transcriptLanguage;
300
305- (void)onProxySettingNotification:(ZoomVideoSDKProxySettingHandler *_Nonnull)handler;
306
311- (void)onSSLCertVerifiedFailNotification:(ZoomVideoSDKSSLCertificateInfo *_Nonnull)handler;
312
313
319- (void)onUserVideoNetworkStatusChanged:(ZoomVideoSDKNetworkStatus)status user:(ZoomVideoSDKUser *_Nullable)user;
320
325- (void)onCallCRCDeviceStatusChanged:(ZoomVideoSDKCRCCallStatus)state;
326
331- (void)onAnnotationHelperCleanUp:(ZoomVideoSDKAnnotationHelper *_Nullable)helper;
332
338- (void)onAnnotationPrivilegeChange:(BOOL)enable shareOwner:(ZoomVideoSDKUser *_Nullable)user DEPRECATED_MSG_ATTRIBUTE("use -[ZoomVideoSDKDelegate onAnnotationPrivilegeChangeWithUser:shareAction:] instead");
339
345- (void)onAnnotationPrivilegeChangeWithUser:(ZoomVideoSDKUser *_Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;
346
354- (void)onShareContentChanged:(ZoomVideoSDKShareHelper *_Nullable)shareHelper user:(ZoomVideoSDKUser *_Nullable)user shareAction:(ZoomVideoSDKShareAction *_Nullable)shareAction;
355
362- (void)onVideoCanvasSubscribeFail:(ZoomVideoSDKSubscribeFailReason)failReason user:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view;
363
370- (void)onShareCanvasSubscribeFail:(ZoomVideoSDKSubscribeFailReason)failReason user:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view DEPRECATED_MSG_ATTRIBUTE("use -[ZoomVideoSDKDelegate onShareCanvasSubscribeFailWithUser:view:shareAction:] instead");
371
378- (void)onShareCanvasSubscribeFailWithUser:(ZoomVideoSDKUser *_Nullable)user view:(UIView *_Nullable)view shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;
379
385- (void)onSendFileStatus:(ZoomVideoSDKSendFile * _Nullable)file status:(ZoomVideoSDKFileTransferStatus)status;
386
392- (void)onReceiveFileStatus:(ZoomVideoSDKReceiveFile * _Nullable)file status:(ZoomVideoSDKFileTransferStatus)status;
393
398- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaChannelOn;
399
405- (void)onSpotlightVideoChanged:(ZoomVideoSDKVideoHelper * _Nullable)videoHelper userList:(NSArray <ZoomVideoSDKUser *>* _Nullable)userList;
406
413- (void)onBindIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;
414
421- (void)onUnbindIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;
422
429- (void)onIncomingLiveStreamStatusResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamsStatusList:(NSArray<ZoomVideoSDKIncomingLiveStreamStatus *> *_Nullable)streamsStatusList;
430
437- (void)onStartIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;
438
445- (void)onStopIncomingLiveStreamResponse:(ZoomVideoSDKIncomingLiveStreamHelper * _Nullable)helper success:(BOOL)success streamKeyID:(NSString *_Nullable)streamKeyID;
446
453- (void)onShareContentSizeChanged:(ZoomVideoSDKShareHelper * _Nullable)helper user:(ZoomVideoSDKUser * _Nullable)user shareAction:(ZoomVideoSDKShareAction*_Nullable)shareAction;
454
455#pragma mark - external camera change -
461- (void)onUVCCameraStatusChange:(ZoomVideoSDKUVCCameraStatus)status;
462
463@end
464
465#pragma mark - ZoomVideoSDKVirtualAudioSpeaker
469@protocol ZoomVideoSDKVirtualAudioSpeaker <NSObject>
470
471@optional
472
477- (void)onVirtualSpeakerMixedAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
478
483- (void)onVirtualSpeakerOneWayAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData user:(ZoomVideoSDKUser * _Nullable)user;
484
489- (void)onVirtualSpeakerSharedAudioReceived:(ZoomVideoSDKAudioRawData * _Nullable)rawData;
490
491@end
492
493#pragma mark - ZoomVideoSDKRawDataPipeDelegate
497@protocol ZoomVideoSDKRawDataPipeDelegate <NSObject>
498
499@optional
500
505- (void)onPixelBuffer:(CVPixelBufferRef _Nullable )pixelBuffer
506 rotation:(ZoomVideoSDKVideoRawDataRotation)rotation;
507
512- (void)onRawDataFrameReceived:(ZoomVideoSDKVideoRawData * _Nullable)rawData;
513
518- (void)onRawDataStatusChanged:(ZoomVideoSDKUserRawdataStatus)userRawdataStatus;
519
520@end
521
522#pragma mark - ZoomVideoSDKVideoSourcePreProcessor
526@protocol ZoomVideoSDKVideoSourcePreProcessor <NSObject>
527
528@optional
533- (void)onPreProcessRawData:(ZoomVideoSDKPreProcessRawData * _Nullable)rawData;
534
535@end
536
537#pragma mark - ZoomVideoSDKVideoSource
541@protocol ZoomVideoSDKVideoSource <NSObject>
542
543@optional
544
551- (void)onInitialize:(ZoomVideoSDKVideoSender *_Nonnull)rawDataSender
552supportCapabilityArray:(NSArray *_Nonnull)supportCapabilityArray
553 suggestCapability:(ZoomVideoSDKVideoCapability *_Nonnull)suggestCapability;
554
560- (void)onPropertyChange:(NSArray *_Nonnull)supportCapabilityArray
561 suggestCapability:(ZoomVideoSDKVideoCapability *_Nonnull)suggestCapability;
562
566- (void)onStartSend;
567
571- (void)onStopSend;
572
576- (void)onUninitialized;
577
578@end
579
583@protocol ZoomVideoSDKVirtualAudioMic <NSObject>
584
585@optional
590- (void)onMicInitialize:(ZoomVideoSDKAudioSender *_Nonnull)rawDataSender;
591
595- (void)onMicStartSend;
596
600- (void)onMicStopSend;
601
605- (void)onMicUninitialized;
606
607@end
608
609#pragma mark - ZoomVideoSDKShareSource
613@protocol ZoomVideoSDKShareSource <NSObject>
614
615@optional
620- (void)onShareSendStarted:(ZoomVideoSDKShareSender *_Nullable)rawDataSender;
621
625- (void)onShareSendStopped;
626
627@end
628
629#pragma mark - ZoomVideoSDKShareAudioSource
633@protocol ZoomVideoSDKShareAudioSource <NSObject>
634
635@optional
640- (void)onStartSendAudio:(ZoomVideoSDKShareAudioSender *_Nonnull)sender;
641
645- (void)onStopSendAudio;
646
647@end
ZoomVideoSDKLiveStreamStatus
ZoomVideoSDKLiveStreamStatus An enumeration of live stream status.
ZoomVideoSDKPhoneFailedReason
The reason for the failure of the telephone call.
ZoomVideoSDKSubscribeFailReason
Enumerations for the video subscribe failed reason.
ZoomVideoSDKUVCCameraStatus
ZoomVideoSDKFileTransferStatus
ZoomVideoSDKMultiCameraStreamStatus
ZoomVideoSDKVideoRawDataRotation
ZoomVideoSDKVideoRawDataRotation The direction of video.
ZoomVideoSDKChatPrivilegeType
Enumerations of the type for chat Privilege type.
ZoomVideoSDKSystemPermissionType
ZoomVideoSDKChatMsgDeleteBy
The chat message delete type are sent in the onChatMsgDeleteNotification:messageID:deleteBy: callback...
ZoomVideoSDKSessionLeaveReason
ZoomVideoSDKError
ZoomVideoSDKError An enumeration of error.
ZoomVideoSDKTestMicStatus
ZoomVideoSDKCRCCallStatus
Enumerations of the type for crc call out status.
ZoomVideoSDKRecordingStatus
An enum representing the status of the recording status.
ZoomVideoSDKNetworkStatus
Type of video network status.
ZoomVideoSDKUserRawdataStatus
user's rawdata status.
ZoomVideoSDKPhoneStatus
Status of telephone.
ZoomVideoSDKLiveTranscriptionStatus
A class to operate the audio action.
A Class contains the information of audio raw data.
A class for user to send audio raw data.
A class to operate the instant message in session.
A class that contains all the information for a message.
A class to operate the live stream.
A Class contains the information of device capture video frame.
A Class to manage the subscription and unsubscription of video or share raw data.
Class for recording agreement action.
Share control interface.
A class for user to send video raw data.
User control interface.
Zoom Video SDK user information.
The video canvas is the display area of the video streams on the user’s local device....
Capabilitiy infomation of video source.
An interface to control video and manage cameras during a video session.
A Class contains the information of video raw data.
A class for user to send video raw data.