Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKDelegate.h
Go to the documentation of this file.
1
8#import <AppKit/AppKit.h>
9#import <ZMVideoSDK/ZMVideoSDKDef.h>
10
11NS_ASSUME_NONNULL_BEGIN
19@class ZMVideoSDKUser;
45@protocol ZMVideoSDKDelegate <NSObject>
46@optional
47
51- (void)onSessionJoin;
52
57- (void)onSessionLeave DEPRECATED_MSG_ATTRIBUTE("Use -onSessionLeave: instead");
58
63- (void)onSessionLeave:(ZMVideoSDKSessionLeaveReason)reason;
64
70- (void)onError:(ZMVideoSDKErrors)ErrorType detail:(int)details;
71
77- (void)onUserJoin:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
78
84- (void)onUserLeave:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
85
91- (void)onUserVideoStatusChanged:(ZMVideoSDKVideoHelper* _Nonnull)videoHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
92
98- (void)onUserAudioStatusChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
99
106- (void)onUserShareStatusChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
107
117- (void)onShareContentSizeChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
118
126- (void)onShareContentChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
127
133- (void)onFailedToStartShare:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user;
134
139- (void)onShareSettingChanged:(ZMVideoSDKShareSetting)setting;
140
146- (void)onLiveStreamStatusChanged:(ZMVideoSDKLiveStreamHelper* _Nonnull)liveStreamHelper liveStreamStatus:(ZMVideoSDKLiveStreamStatus)status;
147
153- (void)onChatNewMessageNotify:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatMessage:(ZMVideoSDKChatMessage* _Nullable)chatMessage;
154
160- (void)onUserHostChanged:(ZMVideoSDKUserHelper* _Nonnull)userHelper user:(ZMVideoSDKUser* _Nullable)user;
161
167- (void)onUserActiveAudioChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
168
173- (void)onSessionNeedPassword:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
174
179- (void)onSessionPasswordWrong:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
180
185- (void)onMixedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data;
186
192- (void)onOneWayAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data user:(ZMVideoSDKUser* _Nullable)user;
193
198- (void)onUserManagerChanged:(ZMVideoSDKUser* _Nullable)user;
199
204- (void)onUserNameChanged:(ZMVideoSDKUser* _Nullable)user;
205
210- (void)onSharedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nullable)data;
211
217- (void)onCloudRecordingStatus:(ZMRecordingStatus)status recordingConsentHandler:(ZMVideoSDKRecordingConsentHandler * _Nullable)handler;
218
223- (void)onUserRecordingConsent:(ZMVideoSDKUser * _Nullable)user;
229- (void)onCommandReceived:(NSString* _Nullable)commandContent senderUser:(ZMVideoSDKUser* _Nullable)user;
230
237- (void)onCameraControlRequestResult:(ZMVideoSDKUser* _Nullable)user approved:(BOOL)isApproved;
238
246- (void)onCameraControlRequestReceived:(ZMVideoSDKUser* _Nullable)user cameraControlRequestType:(ZMVideoSDKCameraControlRequestType)requestType requestHandler:(ZMVideoSDKCameraControlRequestHandler* _Nullable)cameraControlRequestHandler;
247
252- (void)onCommandChannelConnectResult:(BOOL)isSuccess;
253
257- (void)onHostAskUnmute;
258
264- (void)onInviteByPhoneStatus:(ZMPhoneStatus)status reason:(ZMPhoneFailedReason)reason;
265
271- (void)onCalloutJoinSuccess:(ZMVideoSDKUser * _Nullable)user phoneNumber:(NSString * _Nullable)phoneNumber;
272
279- (void)onMultiCameraStreamStatusChanged:(ZMVideoSDKMultiCameraStreamStatus)status user:(ZMVideoSDKUser * _Nullable)user rawDataPipe:(ZMVideoSDKRawDataPipe * _Nullable)videoPipe;
280
287- (void)onAudioLevelChanged:(unsigned int)level audioSharing:(BOOL)bAudioSharing user:(ZMVideoSDKUser * _Nullable)user;
288
294- (void)onMicSpeakerVolumeChanged:(unsigned int)micVolume speakerVolume:(unsigned int)speakerVolume;
295
301- (void)onAudioDeviceStatusChanged:(ZMVideoSDKAudioDeviceType)type status:(ZMVideoSDKAudioDeviceStatus)status;
302
307- (void)onTestMicStatusChanged:(ZMVideoSDKMicTestStatus)status;
308
312- (void)onSelectedAudioDeviceChanged;
313
317- (void)onCameraListChanged;
318
323- (void)onLiveTranscriptionStatus:(ZMVideoSDKLiveTranscriptionStatus)status;
324
329- (void)onLiveTranscriptionMsgInfoReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
330
335- (void)onOriginalLanguageMsgReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
336
342- (void)onLiveTranscriptionMsgError:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage transcriptLanguage:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)transcriptLanguage;
343
348- (void)onSpokenLanguageChanged:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage;
349
356- (void)onChatMsgDeleteNotification:(ZMVideoSDKChatHelper* _Nonnull)chatHelper messageID:(NSString * _Nullable)msgID deleteBy:(ZMVideoSDKChatMessageDeleteType)type;
357
363- (void)onChatPrivilegeChanged:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatPrivilegeType:(ZMVideoSDKChatPrivilegeType)privilege;
364
368- (void)onProxyDetectComplete;
369
374- (void)onProxySettingNotification:(ZMVideoSDKProxySettingHandler * _Nonnull)handler;
375
380- (void)onSSLCertVerifiedFailNotification:(ZMVideoSDKSSLCertificateInfo * _Nonnull)info;
381
388- (void)onUserVideoNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status user:(ZMVideoSDKUser * _Nullable)user DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");
389
396- (void)onShareNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status isSendingShare:(BOOL)isSendingShare DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");
397
404- (void)onUserNetworkStatusChanged:(ZMVideoSDKDataType)type level:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;
405
411- (void)onUserOverallNetworkStatusChanged:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;
412
417- (void)onCallCRCDeviceStatusChanged:(ZMVideoSDKCRCCallStatus)status;
418
425- (void)onVideoCanvasSubscribeFail:(ZMVideoSDKSubscribeFailReason)failReason user:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view;
426
433- (void)onShareCanvasSubscribeFail:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
434
439- (void)onAnnotationHelperCleanUp:(ZMVideoSDKAnnotationHelper* _Nullable)helper;
440
446- (void)onAnnotationPrivilegeChange:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
447
452- (void)onAnnotationHelperActived:(NSView* _Nullable)view;
453
459- (void)onSendFile:(ZMVideoSDKSendFile * _Nullable)sendFile status:(ZMVideoSDKFileTransferStatus)status;
460
466- (void)onReceiveFile:(ZMVideoSDKReceiveFile * _Nullable)receiveFile status:(ZMVideoSDKFileTransferStatus)status;
467
472- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaModeOn;
473
480- (void)onRemoteControlStatus:(ZMVideoSDKRemoteControlStatus)status user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
481
488- (void)onRemoteControlRequestReceived:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction handler:(ZMVideoSDKRemoteControlRequestHandler *)handler;
489
495- (void)onSpotlightVideoChanged:(ZMVideoSDKVideoHelper*)videoHelper userList:(NSArray<ZMVideoSDKUser*>*_Nullable)userlist;
496
502- (void)onBindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
503
509- (void)onUnbindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
510
516- (void)onIncomingLiveStreamStatusResponse:(BOOL)bSuccess streamsStatusList:(NSArray*)streamsStatusList;
517
523- (void)onStartIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
524
530- (void)onStopIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
531
537- (void)onSubSessionStatusChanged:(ZMVideoSDKSubSessionStatus)status subSessionKit:(NSArray<ZMVideoSDKSubSessionKit*>* _Nullable)subSessionKitList;
538
543- (void)onSubSessionManagerHandle:(ZMVideoSDKSubSessionManager* _Nullable)manager;
544
549- (void)onSubSessionParticipantHandle:(ZMVideoSDKSubSessionParticipant* _Nullable)participant;
550
555- (void)onSubSessionUsersUpdate:(ZMVideoSDKSubSessionKit* _Nullable)subSessionKit;
556
562- (void)onBroadcastMessageFromMainSession:(NSString*)message userName:(NSString*)name;
563
568- (void)onSubSessionUserHelpRequest:(ZMVideoSDKSubSessionUserHelpRequestHandler*)handler;
569
574- (void)onSubSessionUserHelpRequestResult:(ZMVideoSDKUserHelpRequestResult)result;
575
582- (void)onWhiteboardExported:(ZMVideoSDKExportFormat)format data:(unsigned char *)data dataLength:(long)length;
583
584
585
591- (void)onUserWhiteboardShareStatusChanged:(ZMVideoSDKUser *)user whiteboardHelper:(ZMVideoSDKWhiteboardHelper *)whiteboardHelper;
592
598- (void)onStartBroadcastResponse:(BOOL)isSuccess channelID:(NSString*)channelID;
599
604- (void)onStopBroadcastResponse:(BOOL)isSuccess;
605
611- (void)onGetBroadcastControlStatus:(BOOL)isSuccess broadcastControlStatus:(ZMVideoSDKBroadcastControlStatus)status;
612
617- (void)onStreamingJoinStatusChanged:(ZMVideoSDKStreamingJoinStatus)status;
618@end
619NS_ASSUME_NONNULL_END
620
ZMVideoSDKMultiCameraStreamStatus
Enumerates the status of multi-camera streams.
ZMVideoSDKDataType
Enumeration of the data type for network quality monitoring.
ZMVideoSDKExportFormat
Enumeration of supported export formats for content, like whiteboard.
ZMVideoSDKSubSessionStatus
Enumeration of subsession statuses.
ZMRecordingStatus
Enumerates the statuses of recording.
ZMVideoSDKMicTestStatus
Enumerates the microphone test statuses.
ZMVideoSDKSubscribeFailReason
Enumerates the reasons for a failed video subscription attempt.
ZMVideoSDKSessionLeaveReason
Enumerates the possible reasons for leaving a session.
ZMVideoSDKAudioDeviceStatus
Enumerates the statuses related to audio device state and availability.
ZMPhoneFailedReason
Enumerates the various reasons for a phone call failure.
ZMVideoSDKFileTransferStatus
Enumeration of file transfer status.
ZMVideoSDKStreamingJoinStatus
Enumerations of streaming join status.
ZMVideoSDKBroadcastControlStatus
Enumerations of broadcast control status.
ZMVideoSDKChatPrivilegeType
Enumerates the types of chat privileges.
ZMVideoSDKChatMessageDeleteType
The chat message delete type are sent in the ZMVideoSDKDelegate#onChatMsgDeleteNotification callback.
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
ZMVideoSDKLiveTranscriptionStatus
Enumerates the status of live transcription.
ZMVideoSDKAudioDeviceType
Enumerates the types of audio devices.
ZMVideoSDKRemoteControlStatus
Enumerates the statuses for remote control.
ZMVideoSDKCameraControlRequestType
Enumerates the types of remote camera control requests.
ZMVideoSDKShareSetting
Enumeration of Zoom Video SDK share setting types.
ZMVideoSDKNetworkStatus
Enumerates the network statuses.
ZMVideoSDKUserHelpRequestResult
Enumeration of subsession user help request results.
ZMVideoSDKLiveStreamStatus
Enumerates the statuses of live streaming.
ZMPhoneStatus
Enumerates the statuses of a phone call.
ZMVideoSDKCRCCallStatus
Enumerates the statuses of a CRC call.
Annotation helper interface for Zoom Video SDK.
Provides methods for managing audio in Zoom Video SDK sessions.
Represents raw audio data received from the SDK.
Camera control request handler object interface.
Chat helper interface.
Represents a chat message within a session.
Helper class for managing outgoing live stream.
Represents a language used in live transcription.
Represents a single message information of live transcription.
Provides methods to manage session password entry when joining a session.
Handles proxy authentication input and provides metadata about the proxy connection.
Video/share raw data pipe interface.
Represents a file being received in the session.
Handler for responding to incoming remote control requests.
Provides details about the SSL certificate used for secure connections.
Represents a file being sent in the session.
Represents the state and control interfaces of a share action in a Zoom session.
Main helper class managing sharing.
Represents a subsession instance.
Manages subsession lifecycle and communication.
Interface for subsession participants.
Handler for user help requests in subsessions.
Represents a user within a subsession.
User control interface.
Zoom Video SDK user information.
Manages the rendering of video or screen share content in the Zoom Video SDK.
An interface to control video and manage cameras during a video session.
Helper class for managing whiteboard functionality in Zoom Video SDK sessions.