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;
40
41
46@protocol ZMVideoSDKDelegate <NSObject>
47@optional
48
52- (void)onSessionJoin;
53
58- (void)onSessionLeave DEPRECATED_MSG_ATTRIBUTE("Use -onSessionLeave: instead");
59
64- (void)onSessionLeave:(ZMVideoSDKSessionLeaveReason)reason;
65
71- (void)onError:(ZMVideoSDKErrors)ErrorType detail:(int)details;
72
78- (void)onUserJoin:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
79
85- (void)onUserLeave:(ZMVideoSDKUserHelper* _Nonnull)userHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
86
92- (void)onUserVideoStatusChanged:(ZMVideoSDKVideoHelper* _Nonnull)videoHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
93
99- (void)onUserAudioStatusChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
100
107- (void)onUserShareStatusChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
108
115- (void)onShareContentSizeChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
116
124- (void)onShareContentChanged:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
125
131- (void)onFailedToStartShare:(ZMVideoSDKShareHelper* _Nonnull)shareHelper user:(ZMVideoSDKUser* _Nullable)user;
132
137- (void)onShareSettingChanged:(ZMVideoSDKShareSetting)setting;
138
144- (void)onLiveStreamStatusChanged:(ZMVideoSDKLiveStreamHelper* _Nonnull)liveStreamHelper liveStreamStatus:(ZMVideoSDKLiveStreamStatus)status;
145
151- (void)onChatNewMessageNotify:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatMessage:(ZMVideoSDKChatMessage* _Nullable)chatMessage;
152
158- (void)onUserHostChanged:(ZMVideoSDKUserHelper* _Nonnull)userHelper user:(ZMVideoSDKUser* _Nullable)user;
159
165- (void)onUserActiveAudioChanged:(ZMVideoSDKAudioHelper* _Nonnull)audioHelper userList:(NSArray<ZMVideoSDKUser *>* _Nullable)userArray;
166
171- (void)onSessionNeedPassword:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
172
177- (void)onSessionPasswordWrong:(ZMVideoSDKPasswordHandler* _Nonnull)handle;
178
183- (void)onMixedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data;
184
190- (void)onOneWayAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nonnull)data user:(ZMVideoSDKUser* _Nullable)user;
191
196- (void)onUserManagerChanged:(ZMVideoSDKUser* _Nullable)user;
197
202- (void)onUserNameChanged:(ZMVideoSDKUser* _Nullable)user;
203
208- (void)onSharedAudioRawDataReceived:(ZMVideoSDKAudioRawData* _Nullable)data;
209
215- (void)onCloudRecordingStatus:(ZMRecordingStatus)status recordingConsentHandler:(ZMVideoSDKRecordingConsentHandler * _Nullable)handler;
216
221- (void)onUserRecordingConsent:(ZMVideoSDKUser * _Nullable)user;
227- (void)onCommandReceived:(NSString* _Nullable)commandContent senderUser:(ZMVideoSDKUser* _Nullable)user;
228
235- (void)onCameraControlRequestResult:(ZMVideoSDKUser* _Nullable)user approved:(BOOL)isApproved;
236
244- (void)onCameraControlRequestReceived:(ZMVideoSDKUser* _Nullable)user cameraControlRequestType:(ZMVideoSDKCameraControlRequestType)requestType requestHandler:(ZMVideoSDKCameraControlRequestHandler* _Nullable)cameraControlRequestHandler;
245
250- (void)onCommandChannelConnectResult:(BOOL)isSuccess;
251
255- (void)onHostAskUnmute;
256
262- (void)onInviteByPhoneStatus:(ZMPhoneStatus)status reason:(ZMPhoneFailedReason)reason;
263
269- (void)onCalloutJoinSuccess:(ZMVideoSDKUser * _Nullable)user phoneNumber:(NSString * _Nullable)phoneNumber;
270
277- (void)onMultiCameraStreamStatusChanged:(ZMVideoSDKMultiCameraStreamStatus)status user:(ZMVideoSDKUser * _Nullable)user rawDataPipe:(ZMVideoSDKRawDataPipe * _Nullable)videoPipe;
278
284- (void)onMicSpeakerVolumeChanged:(unsigned int)micVolume speakerVolume:(unsigned int)speakerVolume;
285
291- (void)onAudioDeviceStatusChanged:(ZMVideoSDKAudioDeviceType)type status:(ZMVideoSDKAudioDeviceStatus)status;
292
297- (void)onTestMicStatusChanged:(ZMVideoSDKMicTestStatus)status;
298
302- (void)onSelectedAudioDeviceChanged;
303
307- (void)onCameraListChanged;
308
313- (void)onLiveTranscriptionStatus:(ZMVideoSDKLiveTranscriptionStatus)status;
314
319- (void)onLiveTranscriptionMsgInfoReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
320
325- (void)onOriginalLanguageMsgReceived:(ZMVideoSDKLiveTranscriptionMessageInfo* _Nullable)messageInfo;
326
332- (void)onLiveTranscriptionMsgError:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage transcriptLanguage:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)transcriptLanguage;
333
338- (void)onSpokenLanguageChanged:(ZMVideoSDKLiveTranscriptionLanguage* _Nullable)spokenLanguage;
339
346- (void)onChatMsgDeleteNotification:(ZMVideoSDKChatHelper* _Nonnull)chatHelper messageID:(NSString * _Nullable)msgID deleteBy:(ZMVideoSDKChatMessageDeleteType)type;
347
353- (void)onChatPrivilegeChanged:(ZMVideoSDKChatHelper* _Nonnull)chatHelper chatPrivilegeType:(ZMVideoSDKChatPrivilegeType)privilege;
354
358- (void)onProxyDetectComplete;
359
364- (void)onProxySettingNotification:(ZMVideoSDKProxySettingHandler * _Nonnull)handler;
365
370- (void)onSSLCertVerifiedFailNotification:(ZMVideoSDKSSLCertificateInfo * _Nonnull)info;
371
377- (void)onUserVideoNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status user:(ZMVideoSDKUser * _Nullable)user;
378
384- (void)onShareNetworkStatusChanged:(ZMVideoSDKNetworkStatus)status isSendingShare:(BOOL)isSendingShare;
385
390- (void)onCallCRCDeviceStatusChanged:(ZMVideoSDKCRCCallStatus)status;
391
398- (void)onVideoCanvasSubscribeFail:(ZMVideoSDKSubscribeFailReason)failReason user:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view;
399
406- (void)onShareCanvasSubscribeFail:(ZMVideoSDKUser* _Nullable)user view:(NSView* _Nullable)view shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
407
412- (void)onAnnotationHelperCleanUp:(ZMVideoSDKAnnotationHelper* _Nullable)helper;
413
419- (void)onAnnotationPrivilegeChange:(ZMVideoSDKUser* _Nullable)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
420
425- (void)onAnnotationHelperActived:(NSView* _Nullable)view;
426
432- (void)onSendFile:(ZMVideoSDKSendFile * _Nullable)sendFile status:(ZMVideoSDKFileTransferStatus)status;
433
439- (void)onReceiveFile:(ZMVideoSDKReceiveFile * _Nullable)receiveFile status:(ZMVideoSDKFileTransferStatus)status;
440
445- (void)onVideoAlphaChannelStatusChanged:(BOOL)isAlphaModeOn;
446
453- (void)onRemoteControlStatus:(ZMVideoSDKRemoteControlStatus)status user:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction;
454
461- (void)onRemoteControlRequestReceived:(ZMVideoSDKUser *)user shareAction:(ZMVideoSDKShareAction* _Nullable)shareAction handler:(ZMVideoSDKRemoteControlRequestHandler *)handler;
462
468- (void)onSpotlightVideoChanged:(ZMVideoSDKVideoHelper*)videoHelper userList:(NSArray<ZMVideoSDKUser*>*_Nullable)userlist;
469
475- (void)onBindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
476
482- (void)onUnbindIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
483
489- (void)onIncomingLiveStreamStatusResponse:(BOOL)bSuccess streamsStatusList:(NSArray*)streamsStatusList;
490
496- (void)onStartIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
497
503- (void)onStopIncomingLiveStreamResponse:(BOOL)bSuccess streamKeyID:(NSString*)streamKeyID;
504
510- (void)onSubSessionStatusChanged:(ZMVideoSDKSubSessionStatus)status subSessionKit:(NSArray<ZMVideoSDKSubSessionKit*>* _Nullable)subSessionKitList;
511
516- (void)onSubSessionManagerHandle:(ZMVideoSDKSubSessionManager* _Nullable)manager;
517
522- (void)onSubSessionParticipantHandle:(ZMVideoSDKSubSessionParticipant* _Nullable)participant;
523
528- (void)onSubSessionUsersUpdate:(ZMVideoSDKSubSessionKit* _Nullable)subSessionKit;
529
535- (void)onBroadcastMessageFromMainSession:(NSString*)message userName:(NSString*)name;
536
541- (void)onSubSessionUserHelpRequest:(ZMVideoSDKSubSessionUserHelpRequestHandler*)handler;
542
547- (void)onSubSessionUserHelpRequestResult:(ZMVideoSDKUserHelpRequestResult)result;
548@end
549NS_ASSUME_NONNULL_END
550
ZMVideoSDKMultiCameraStreamStatus
Enumerates the status of multi-camera streams.
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.
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.
Provides functions to control virtual background.