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
135- (void)onUnsharingWindowsChanged:(NSArray<NSNumber*>*)windowsList shareHelper:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
136
142- (void)onFailedToStartShare:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user;
143
148- (void)onShareSettingChanged:(ZMVideoSDKShareSetting)setting;
149
155- (void)onLiveStreamStatusChanged:(ZMVideoSDKLiveStreamHelper* _Nonnull)liveStreamHelper liveStreamStatus:(ZMVideoSDKLiveStreamStatus)status;
156
162- (void)onChatNewMessageNotify:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatMessage:(ZMVideoSDKChatMessage* _Nullable)chatMessage;
163
169- (void)onUserHostChanged:(ZMVideoSDKUserHelper* _Nonnull)userHelper user:(ZMVideoSDKUser* _Nullable)user;
170
176- (void)onUserActiveAudioChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
177
182- (void)onSessionNeedPassword:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
183
188- (void)onSessionPasswordWrong:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
189
194- (void)onMixedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data;
195
201- (void)onOneWayAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data user:(ZMVideoSDKUser* _Nullable)user;
202
207- (void)onUserManagerChanged:(ZMVideoSDKUser* _Nullable)user;
208
213- (void)onUserNameChanged:(ZMVideoSDKUser* _Nullable)user;
214
219- (void)onSharedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nullable)data;
220
226- (void)onCloudRecordingStatus:(ZMRecordingStatus)status recordingConsentHandler:(ZMVideoSDKRecordingConsentHandler * _Nullable)handler;
227
232- (void)onUserRecordingConsent:(ZMVideoSDKUser * _Nullable)user;
238- (void)onCommandReceived:(NSString* _Nullable)commandContent senderUser:(ZMVideoSDKUser* _Nullable)user;
239
246- (void)onCameraControlRequestResult:(ZMVideoSDKUser* _Nullable)user approved:(BOOL)isApproved;
247
255- (void)onCameraControlRequestReceived:(ZMVideoSDKUser* _Nullable)user cameraControlRequestType:(ZMVideoSDKCameraControlRequestType)requestType requestHandler:(ZMVideoSDKCameraControlRequestHandler* _Nullable)cameraControlRequestHandler;
256
261- (void)onCommandChannelConnectResult:(BOOL)isSuccess;
262
266- (void)onHostAskUnmute;
267
273- (void)onInviteByPhoneStatus:(ZMPhoneStatus)status reason:(ZMPhoneFailedReason)reason;
274
280- (void)onCalloutJoinSuccess:(ZMVideoSDKUser * _Nullable)user phoneNumber:(NSString * _Nullable)phoneNumber;
281
288- (void)onMultiCameraStreamStatusChanged:(ZMVideoSDKMultiCameraStreamStatus)status user:(ZMVideoSDKUser * _Nullable)user rawDataPipe:(ZMVideoSDKRawDataPipe * _Nullable)videoPipe;
289
296- (void)onAudioLevelChanged:(unsigned int)level audioSharing:(BOOL)bAudioSharing user:(ZMVideoSDKUser * _Nullable)user;
297
303- (void)onMicSpeakerVolumeChanged:(unsigned int)micVolume speakerVolume:(unsigned int)speakerVolume;
304
310- (void)onAudioDeviceStatusChanged:(ZMVideoSDKAudioDeviceType)type status:(ZMVideoSDKAudioDeviceStatus)status;
311
316- (void)onTestMicStatusChanged:(ZMVideoSDKMicTestStatus)status;
317
321- (void)onSelectedAudioDeviceChanged;
322
326- (void)onCameraListChanged;
327
332- (void)onLiveTranscriptionStatus:(ZMVideoSDKLiveTranscriptionStatus)status;
333
338- (void)onLiveTranscriptionMsgInfoReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
339
344- (void)onOriginalLanguageMsgReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
345
351- (void)onLiveTranscriptionMsgError:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage transcriptLanguage:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)transcriptLanguage;
352
357- (void)onSpokenLanguageChanged:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage;
358
365- (void)onChatMsgDeleteNotification:(ZMVideoSDKChatHelper* _Nonnull)chatHelper messageID:(NSString * _Nullable)msgID deleteBy:(ZMVideoSDKChatMessageDeleteType)type;
366
372- (void)onChatPrivilegeChanged:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatPrivilegeType:(ZMVideoSDKChatPrivilegeType)privilege;
373
377- (void)onProxyDetectComplete;
378
383- (void)onProxySettingNotification:(ZMVideoSDKProxySettingHandler * _Nonnull)handler;
384
389- (void)onSSLCertVerifiedFailNotification:(ZMVideoSDKSSLCertificateInfo * _Nonnull)info;
390
397- (void)onUserVideoNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status user:(ZMVideoSDKUser * _Nullable)user DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");
398
405- (void)onShareNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status isSendingShare:(BOOL)isSendingShare DEPRECATED_MSG_ATTRIBUTE("Use -onUserNetworkStatusChanged:level:user: instead");
406
413- (void)onUserNetworkStatusChanged:(ZMVideoSDKDataType)type level:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;
414
420- (void)onUserOverallNetworkStatusChanged:(ZMVideoSDKNetworkStatus)level user:(ZMVideoSDKUser *)user;
421
426- (void)onCallCRCDeviceStatusChanged:(ZMVideoSDKCRCCallStatus)status;
427
434- (void)onVideoCanvasSubscribeFail:(ZMVideoSDKSubscribeFailReason)failReason user:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view;
435
442- (void)onShareCanvasSubscribeFail:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
443
448- (void)onAnnotationHelperCleanUp:(ZMVideoSDKAnnotationHelper* _Nullable)helper;
449
455- (void)onAnnotationPrivilegeChange:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
456
461- (void)onAnnotationHelperActived:(NSView* _Nullable)view;
462
468- (void)onSendFile:(ZMVideoSDKSendFile * _Nullable)sendFile status:(ZMVideoSDKFileTransferStatus)status;
469
475- (void)onReceiveFile:(ZMVideoSDKReceiveFile * _Nullable)receiveFile status:(ZMVideoSDKFileTransferStatus)status;
476
481- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaModeOn;
482
489- (void)onRemoteControlStatus:(ZMVideoSDKRemoteControlStatus)status user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
490
497- (void)onRemoteControlRequestReceived:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction handler:(ZMVideoSDKRemoteControlRequestHandler *)handler;
498
504- (void)onSpotlightVideoChanged:(ZMVideoSDKVideoHelper*)videoHelper userList:(NSArray<ZMVideoSDKUser*>*_Nullable)userlist;
505
511- (void)onBindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
512
518- (void)onUnbindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
519
525- (void)onIncomingLiveStreamStatusResponse:(BOOL)bSuccess streamsStatusList:(NSArray*)streamsStatusList;
526
532- (void)onStartIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
533
539- (void)onStopIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
540
546- (void)onSubSessionStatusChanged:(ZMVideoSDKSubSessionStatus)status subSessionKit:(NSArray<ZMVideoSDKSubSessionKit*>* _Nullable)subSessionKitList;
547
552- (void)onSubSessionManagerHandle:(ZMVideoSDKSubSessionManager* _Nullable)manager;
553
558- (void)onSubSessionParticipantHandle:(ZMVideoSDKSubSessionParticipant* _Nullable)participant;
559
564- (void)onSubSessionUsersUpdate:(ZMVideoSDKSubSessionKit* _Nullable)subSessionKit;
565
571- (void)onBroadcastMessageFromMainSession:(NSString*)message userName:(NSString*)name;
572
577- (void)onSubSessionUserHelpRequest:(ZMVideoSDKSubSessionUserHelpRequestHandler*)handler;
578
583- (void)onSubSessionUserHelpRequestResult:(ZMVideoSDKUserHelpRequestResult)result;
584
591- (void)onWhiteboardExported:(ZMVideoSDKExportFormat)format data:(unsigned char *)data dataLength:(long)length;
592
593
594
600- (void)onUserWhiteboardShareStatusChanged:(ZMVideoSDKUser *)user whiteboardHelper:(ZMVideoSDKWhiteboardHelper *)whiteboardHelper;
601
607- (void)onStartBroadcastResponse:(BOOL)isSuccess channelID:(NSString*)channelID;
608
613- (void)onStopBroadcastResponse:(BOOL)isSuccess;
614
620- (void)onGetBroadcastControlStatus:(BOOL)isSuccess broadcastControlStatus:(ZMVideoSDKBroadcastControlStatus)status;
621
626- (void)onStreamingJoinStatusChanged:(ZMVideoSDKStreamingJoinStatus)status;
627
632- (void)onRealTimeMediaStreamsStatusChanged:(ZMVideoSDKRealTimeMediaStreamsStatus)status;
633
638- (void)onRealTimeMediaStreamsFail:(ZMVideoSDKRealTimeMediaStreamsFailReason)failReason;
639@end
640NS_ASSUME_NONNULL_END
641
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.
ZMVideoSDKRealTimeMediaStreamsStatus
real-time media streams status. Here are more detailed structural descriptions.
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.
ZMVideoSDKRealTimeMediaStreamsFailReason
Failure reasons for RealTimeMediaStreams. Here are more detailed structural descriptions.
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.