Video SDK for Linux API Reference
Loading...
Searching...
No Matches
zoom_video_sdk_delegate_interface.h
Go to the documentation of this file.
1
6#ifndef _ZOOM_VIDEO_SDK_DELEGATE_INTERFACE_H_
7#define _ZOOM_VIDEO_SDK_DELEGATE_INTERFACE_H_
26#if !defined (__linux) || defined ANDROID
27#include "helpers/zoom_video_sdk_rtms_helper_interface.h"
28#endif
35class IZoomVideoSDKRemoteControlRequestHandler;
41{
42public:
46 virtual void onSessionJoin() = 0;
47
52 virtual void onSessionLeave() = 0;
53
59
65 virtual void onError(ZoomVideoSDKErrors errorCode, int detailErrorCode) = 0;
66
73
80
87
94
102
109 virtual void onShareContentChanged(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;
110
116 virtual void onFailedToStartShare(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser) = 0;
117
123
129
136
142 virtual void onChatNewMessageNotify(IZoomVideoSDKChatHelper* pChatHelper, IZoomVideoSDKChatMessage* messageItem) = 0;
143
149 virtual void onUserHostChanged(IZoomVideoSDKUserHelper* pUserHelper, IZoomVideoSDKUser* pUser) = 0;
150
157
163
169
175
182
188
193 virtual void onUserManagerChanged(IZoomVideoSDKUser* pUser) = 0;
194
199 virtual void onUserNameChanged(IZoomVideoSDKUser* pUser) = 0;
200
207 virtual void onCameraControlRequestResult(IZoomVideoSDKUser* pUser, bool isApproved) = 0;
208
218 IZoomVideoSDKCameraControlRequestHandler* pCameraControlRequestHandler) = 0;
219
220#if defined(WIN32) || defined(__MACOS__)
227 virtual void onRemoteControlStatus(IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction, ZoomVideoSDKRemoteControlStatus status) = 0;
228
236 virtual void onRemoteControlRequestReceived(IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction,
237 IZoomVideoSDKRemoteControlRequestHandler* pRemoteControlRequestHandler) = 0;
238#endif
239
240#if defined(WIN32)
245 virtual void onRemoteControlServiceInstallResult(bool bSuccess) = 0;
246#endif
247
254 virtual void onCommandReceived(IZoomVideoSDKUser* sender, const zchar_t* strCmd) = 0;
255
263 virtual void onCommandChannelConnectResult(bool isSuccess) = 0;
264
270 virtual void onInviteByPhoneStatus(PhoneStatus status, PhoneFailedReason reason) = 0;
271
277 virtual void onCalloutJoinSuccess(IZoomVideoSDKUser* pUser, const zchar_t* phoneNumber) = 0;
278
285
289 virtual void onHostAskUnmute() = 0;
290
298
304 virtual void onMicSpeakerVolumeChanged(unsigned int micVolume, unsigned int speakerVolume) = 0;
305
312 virtual void onAudioLevelChanged(unsigned int level, bool bAudioSharing, IZoomVideoSDKUser* pUser) = 0;
313
320
327
332
336 virtual void onCameraListChanged() = 0;
337
343
349
355
361 virtual void onLiveTranscriptionMsgError(ILiveTranscriptionLanguage* spokenLanguage, ILiveTranscriptionLanguage* transcriptLanguage) = 0;
362
367 virtual void onSpokenLanguageChanged(ILiveTranscriptionLanguage* spokenLanguage) = 0;
368
376
383
389 virtual void onSendFileStatus(IZoomVideoSDKSendFile* file, const FileTransferStatus& status) = 0;
390
397
401 virtual void onProxyDetectComplete() = 0;
402
409
415
423
430 virtual void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus, bool isSendingShare) = 0;
431
439
446
452
453#if !defined __linux
460 virtual void onVideoCanvasSubscribeFail(ZoomVideoSDKSubscribeFailReason fail_reason, IZoomVideoSDKUser* pUser, void* handle) = 0;
461
468 virtual void onShareCanvasSubscribeFail(IZoomVideoSDKUser* pUser, void* handle, IZoomVideoSDKShareAction* pShareAction) = 0;
469#endif
470
477
484
489 virtual void onAnnotationHelperActived(void* handle) = 0;
490
498
503 virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn) = 0;
504
511
517 virtual void onBindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;
518
524 virtual void onUnbindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;
525
531 virtual void onIncomingLiveStreamStatusResponse(bool bSuccess, IVideoSDKVector<IncomingLiveStreamStatus>* pStreamsStatusList) = 0;
532
538 virtual void onStartIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;
539
545 virtual void onStopIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;
546
557
568
584
590
596
601 virtual void onSubSessionUsersUpdate(ISubSessionKit* pSubSessionKit) = 0;
602
608 virtual void onBroadcastMessageFromMainSession(const zchar_t* sMessage, const zchar_t* sUserName) = 0;
609
615
621
627 virtual void onStartBroadcastResponse(bool bSuccess, const zchar_t* channelID) = 0;
628
633 virtual void onStopBroadcastResponse(bool bSuccess) = 0;
634
641
647
648#if !defined (__linux) || defined ANDROID
655 virtual void onWhiteboardExported(ZoomVideoSDKExportFormat format, unsigned char* data, long length) = 0;
656
657
658
665
670 virtual void onRealTimeMediaStreamsStatus(RealTimeMediaStreamsStatus status) = 0;
671
676 virtual void onRealTimeMediaStreamsFail(RealTimeMediaStreamsFailReason failReason) = 0;
677#endif
678
684 virtual void onCanvasSnapshotTaken(IZoomVideoSDKUser* pUser, bool isShare) = 0;
685
691};
693#endif
The audio raw data handler interface.
SDK-defined vector interface for managing collections of items.
A listener class that groups together the callbacks related to a session.
virtual void onUserNameChanged(IZoomVideoSDKUser *pUser)=0
Notification of user name changed.
virtual void onCanvasSnapshotTaken(IZoomVideoSDKUser *pUser, bool isShare)=0
Callback invoked when a canvas snapshot is successfully taken.
virtual void onUserActiveAudioChanged(IZoomVideoSDKAudioHelper *pAudioHelper, IVideoSDKVector< IZoomVideoSDKUser * > *list)=0
Notification of the active audio changes.
virtual void onLiveStreamStatusChanged(IZoomVideoSDKLiveStreamHelper *pLiveStreamHelper, ZoomVideoSDKLiveStreamStatus status)=0
Notification of a user makes changes to their live stream status.
virtual void onUserVideoStatusChanged(IZoomVideoSDKVideoHelper *pVideoHelper, IVideoSDKVector< IZoomVideoSDKUser * > *userList)=0
Notification of a user makes changes to their video, such as starting or stopping their video.
virtual void onAudioLevelChanged(unsigned int level, bool bAudioSharing, IZoomVideoSDKUser *pUser)=0
Notification of the audio level changes for a participant (excluding self).
virtual void onUserNetworkStatusChanged(ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser)=0
Notification of user's network status changes for a specific data type.
virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn)=0
Notification of video alpha channel mode changed.
virtual void onSessionLeave()=0
Notification of leaving the session.
virtual void onSessionLeave(ZoomVideoSDKSessionLeaveReason eReason)=0
Notification of leaving the session with reason.
virtual void onSessionNeedPassword(IZoomVideoSDKPasswordHandler *handler)=0
Notification of the session requires a password to join.
virtual void onAnnotationHelperActived(void *handle)=0
Notification of the annotation helper activated. Notify that annotation windows have been created.
virtual void onIncomingLiveStreamStatusResponse(bool bSuccess, IVideoSDKVector< IncomingLiveStreamStatus > *pStreamsStatusList)=0
Notification of the response that gets the streams status.
virtual void onUserAudioStatusChanged(IZoomVideoSDKAudioHelper *pAudioHelper, IVideoSDKVector< IZoomVideoSDKUser * > *userList)=0
Notification of a user makes changes to their audio, such as muting or unmuting their audio.
virtual void onRealTimeMediaStreamsFail(RealTimeMediaStreamsFailReason failReason)=0
Notification of the real-time media stream failure reason.
virtual void onStopIncomingLiveStreamResponse(bool bSuccess, const zchar_t *strStreamKeyID)=0
Notification of the response that stops the bound stream.
virtual void onOneWayAudioRawDataReceived(AudioRawData *data_, IZoomVideoSDKUser *pUser)=0
Notification of individual user's audio raw data received.
virtual void onSubSessionUserHelpRequestResult(ZoomVideoSDKUserHelpRequestResult eResult)=0
Notification of the result of the help request.
virtual void onVideoCanvasSubscribeFail(ZoomVideoSDKSubscribeFailReason fail_reason, IZoomVideoSDKUser *pUser, void *handle)=0
Notification of the subscribed user's video failure reason.
virtual void onGetBroadcastControlStatus(bool bSuccess, ZoomVideoSDKBroadcastControlStatus status)=0
Notification the response of getting broadcast status.
virtual void onTestMicStatusChanged(ZoomVideoSDK_TESTMIC_STATUS status)=0
Notification of the mic status changed when testing.
virtual void onBindIncomingLiveStreamResponse(bool bSuccess, const zchar_t *strStreamKeyID)=0
Notification of the response that binding the incoming live stream.
virtual void onUnbindIncomingLiveStreamResponse(bool bSuccess, const zchar_t *strStreamKeyID)=0
Notification of the response that unbinding the incoming live stream.
virtual void onAnnotationPrivilegeChange(IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of the annotation privilege change.
virtual void onUserShareStatusChanged(IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of a user makes changes to their sharing status, such as starting screen sharing,...
virtual void onShareContentSizeChanged(IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of the share content size has changed.
virtual void onUserJoin(IZoomVideoSDKUserHelper *pUserHelper, IVideoSDKVector< IZoomVideoSDKUser * > *userList)=0
Notification of a user joins the session.
virtual void onSessionPasswordWrong(IZoomVideoSDKPasswordHandler *handler)=0
Notification of the provided session password is wrong or invalid.
virtual void onRealTimeMediaStreamsStatus(RealTimeMediaStreamsStatus status)=0
Notification of the real-time media stream's status changed.
virtual void onSubSessionUserHelpRequest(ISubSessionUserHelpRequestHandler *pHandler)=0
Notification of the user receives a help request from a subsession.
virtual void onUnsharingWindowsChanged(IVideoSDKVector< void * > *windowsList, IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of the list of unsharing windows changes.
virtual void onUserOverallNetworkStatusChanged(ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser)=0
Notification of user's overall network status changes.
virtual void onSelectedAudioDeviceChanged()=0
Notification of the selected mic/speaker device is changed when testing. Then the SDK will close the ...
virtual void onShareCanvasSubscribeFail(IZoomVideoSDKUser *pUser, void *handle, IZoomVideoSDKShareAction *pShareAction)=0
Notification of the subscribed user's share view failure reason.
virtual void onUserVideoNetworkStatusChanged(ZoomVideoSDKNetworkStatus status, IZoomVideoSDKUser *pUser)=0
Notification of the user's video network quality changes.
virtual void onWhiteboardExported(ZoomVideoSDKExportFormat format, unsigned char *data, long length)=0
Callback invoked when a whiteboard file export completes.
virtual void onCanvasSnapshotIncompatible(IZoomVideoSDKUser *pUser)=0
Callback invoked when a canvas snapshot is attempted but cannot be taken due to compatibility issues ...
virtual void onAnnotationHelperCleanUp(IZoomVideoSDKAnnotationHelper *helper)=0
Notification of the annotation helper clean up.
virtual void onInviteByPhoneStatus(PhoneStatus status, PhoneFailedReason reason)=0
Notification of the invite by phone status changes to any other valid status such as Calling,...
virtual void onError(ZoomVideoSDKErrors errorCode, int detailErrorCode)=0
Notification of errors occur when join session.
virtual void onSubSessionParticipantHandle(IZoomVideoSDKSubSessionParticipant *pParticipant)=0
Notification of a user gains or loses subsession participant privileges.
virtual void onUserManagerChanged(IZoomVideoSDKUser *pUser)=0
Notification of the manager of the session changes.
virtual void onCameraControlRequestResult(IZoomVideoSDKUser *pUser, bool isApproved)=0
Notification of the current user is granted camera control access.
virtual void onStopBroadcastResponse(bool bSuccess)=0
Notification the response of stopping broadcast streaming.
virtual void onLiveTranscriptionStatus(ZoomVideoSDKLiveTranscriptionStatus status)=0
Notification of live transcription status changes.
virtual void onUserLeave(IZoomVideoSDKUserHelper *pUserHelper, IVideoSDKVector< IZoomVideoSDKUser * > *userList)=0
Notification of a user leaves the session.
virtual void onSubSessionManagerHandle(IZoomVideoSDKSubSessionManager *pManager)=0
Notification of the user has subsession manager privilege.
virtual void onHostAskUnmute()=0
Notification of a host requests you to unmute yourself.
virtual void onStreamingJoinStatusChanged(ZoomVideoSDKStreamingJoinStatus status)=0
Notification when the viewer's join status changes.
virtual void onSubSessionStatusChanged(ZoomVideoSDKSubSessionStatus status, IVideoSDKVector< ISubSessionKit * > *pSubSessionKitList)=0
Notification of the subsession status changed.
virtual void onSpotlightVideoChanged(IZoomVideoSDKVideoHelper *pVideoHelper, IVideoSDKVector< IZoomVideoSDKUser * > *userList)=0
Notification of spotlighted video user changed.
virtual void onCallCRCDeviceStatusChanged(ZoomVideoSDKCRCCallStatus status)=0
Notification of the call CRC device's status changed.
virtual void onSSLCertVerifiedFailNotification(IZoomVideoSDKSSLCertificateInfo *info)=0
Notification of the SSL verified fail.
virtual void onChatPrivilegeChanged(IZoomVideoSDKChatHelper *pChatHelper, ZoomVideoSDKChatPrivilegeType privilege)=0
Notification of the chat privilege of participant has changed.
virtual void onProxyDetectComplete()=0
Notification of completing the proxy detection.
virtual void onMicSpeakerVolumeChanged(unsigned int micVolume, unsigned int speakerVolume)=0
Notification of the current mic or speaker volume changed.
virtual void onLiveTranscriptionMsgInfoReceived(ILiveTranscriptionMessageInfo *messageInfo)=0
Notification of a live transcription message is received.
virtual void onSessionJoin()=0
Notification of joining the session.
virtual void onUserWhiteboardShareStatusChanged(IZoomVideoSDKUser *pUser, IZoomVideoSDKWhiteboardHelper *pWhiteboardHelper)=0
Callback invoked when a user changes their whiteboard sharing status, such as starting or stopping wh...
virtual void onCommandChannelConnectResult(bool isSuccess)=0
Notification of the command channel is ready to be used.
virtual void onBroadcastMessageFromMainSession(const zchar_t *sMessage, const zchar_t *sUserName)=0
Notification of the user receives a main session broadcast message.
virtual void onMixedAudioRawDataReceived(AudioRawData *data_)=0
Notification of mixed (all users) audio raw data received.
virtual void onStartIncomingLiveStreamResponse(bool bSuccess, const zchar_t *strStreamKeyID)=0
Notification of the response that starts the bound stream.
virtual void onChatNewMessageNotify(IZoomVideoSDKChatHelper *pChatHelper, IZoomVideoSDKChatMessage *messageItem)=0
Notification of receiving a chat message.
virtual void onMultiCameraStreamStatusChanged(ZoomVideoSDKMultiCameraStreamStatus status, IZoomVideoSDKUser *pUser, IZoomVideoSDKRawDataPipe *pVideoPipe)=0
Notification of someone in a given session enables or disables multi-camera. All participants in the ...
virtual void onCameraListChanged()=0
Notification of the camera list has changed.
virtual void onReceiveFileStatus(IZoomVideoSDKReceiveFile *file, const FileTransferStatus &status)=0
Notification of receive file status changed.
virtual void onShareSettingChanged(ZoomVideoSDKShareSetting setting)=0
Notification of share setting changed.
virtual void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus, bool isSendingShare)=0
Notification of the current user's share network quality changes.
virtual void onCloudRecordingStatus(RecordingStatus status, IZoomVideoSDKRecordingConsentHandler *pHandler)=0
Notification of cloud recording status has paused, stopped, resumed, or otherwise changed.
virtual void onCommandReceived(IZoomVideoSDKUser *sender, const zchar_t *strCmd)=0
Notification of receiving a message, data, or a command from the command channel.
virtual void onAudioDeviceStatusChanged(ZoomVideoSDKAudioDeviceType type, ZoomVideoSDKAudioDeviceStatus status)=0
Notification of mic device or speaker device status changed.
virtual void onSendFileStatus(IZoomVideoSDKSendFile *file, const FileTransferStatus &status)=0
Notification of send file status make change.
virtual void onCalloutJoinSuccess(IZoomVideoSDKUser *pUser, const zchar_t *phoneNumber)=0
Notification of the callout user successfully joins the meeting.
virtual void onUserHostChanged(IZoomVideoSDKUserHelper *pUserHelper, IZoomVideoSDKUser *pUser)=0
Notification of the session host changes.
virtual void onOriginalLanguageMsgReceived(ILiveTranscriptionMessageInfo *messageInfo)=0
Notification of original language message received.
virtual void onStartBroadcastResponse(bool bSuccess, const zchar_t *channelID)=0
Notification the response of starting broadcast streaming.
virtual void onUserRecordingConsent(IZoomVideoSDKUser *pUser)=0
Notification of a user consents to individual recording.
virtual void onSharedAudioRawDataReceived(AudioRawData *data_)=0
Notification of receiving shared raw audio data.
virtual void onShareContentChanged(IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of a user makes changes to their share content type, such as camera share switch to norm...
virtual void onProxySettingNotification(IZoomVideoSDKProxySettingHandler *handler)=0
Notification of the proxy requests to input the username and password.
virtual void onSpokenLanguageChanged(ILiveTranscriptionLanguage *spokenLanguage)=0
Notification of the spoken language has changed.
virtual void onSubSessionUsersUpdate(ISubSessionKit *pSubSessionKit)=0
Notification of the subsession users are updated..
virtual void onSharingActiveMonitorChanged(IVideoSDKVector< void * > *monitorIDs, IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser, IZoomVideoSDKShareAction *pShareAction)=0
Notification of the active monitor(s) displaying the shared content has changed.
virtual void onLiveTranscriptionMsgError(ILiveTranscriptionLanguage *spokenLanguage, ILiveTranscriptionLanguage *transcriptLanguage)=0
Notification of a live translation error occurs.
virtual void onChatMsgDeleteNotification(IZoomVideoSDKChatHelper *pChatHelper, const zchar_t *msgID, ZoomVideoSDKChatMessageDeleteType deleteBy)=0
Notification of a user deletes a chat message.
virtual void onCameraControlRequestReceived(IZoomVideoSDKUser *pUser, ZoomVideoSDKCameraControlRequestType requestType, IZoomVideoSDKCameraControlRequestHandler *pCameraControlRequestHandler)=0
Notification of the current user has received a camera control request.
virtual void onFailedToStartShare(IZoomVideoSDKShareHelper *pShareHelper, IZoomVideoSDKUser *pUser)=0
Notification of a user failed to start sharing.
virtual void onAnnotationToolTypeChanged(IZoomVideoSDKAnnotationHelper *helper, void *handle, ZoomVideoSDKAnnotationToolType toolType)=0
Notification of the annotation tool type changed.
Video/share raw data pipe interface.
Interface for managing a file that is being received in the Zoom Video SDK. Inherits from IZoomVideoS...
Interface for managing a file that is being sent in the Zoom Video SDK. Inherits from IZoomVideoSDKFi...
Subsession participant helper interface.
An interface to control video and manage cameras during a video session.
ZoomVideoSDKAnnotationToolType
Enumeration of annotation tool types.
Audio setting helper interface.
ZoomVideoSDKAudioDeviceStatus
Enumeration of audio device status types.
ZoomVideoSDKAudioDeviceType
Enumeration of audio device types.
ZoomVideoSDKBroadcastControlStatus
Enumerations of broadcast control status.
ZoomVideoSDKStreamingJoinStatus
Streaming join status enumeration.
ZoomVideoSDKChatPrivilegeType
The chat privilege type are sent in the onChatPrivilegeChanged callback.
ZoomVideoSDKChatMessageDeleteType
The chat message delete type are sent in the onChatMsgDeleteNotification callback.
ZoomVideoSDKCRCCallStatus
CRC call status. Here are more detailed structural descriptions.
Zoom Video SDK Common Definition File.
ZoomVideoSDKLiveStreamStatus
Enumeration of live streaming status in Zoom Video SDK.
RecordingStatus
Enumeration representing the status of recording.
ZoomVideoSDKDataType
Enumeration of the data type for network quality monitoring.
#define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
ZoomVideoSDK_TESTMIC_STATUS
Enumeration of the microphone test status in Zoom Video SDK.
ZoomVideoSDKCameraControlRequestType
Enumeration of camera control request types in Zoom Video SDK.
ZoomVideoSDKSessionLeaveReason
Enumeration of session leave reasons in Zoom Video SDK.
ZoomVideoSDKExportFormat
Enumeration of supported export formats for content, like whiteboard.
FileTransferStatus
Enumeration representing the status of a file transfer.
#define END_ZOOM_VIDEO_SDK_NAMESPACE
ZoomVideoSDKRemoteControlStatus
Enumeration of remote control status in Zoom Video SDK.
ZoomVideoSDKErrors
Enumeration of common Zoom Video SDK errors.
ZoomVideoSDKShareSetting
Enumeration of Zoom Video SDK share setting types.
Live transcription helper interface.
ZoomVideoSDKLiveTranscriptionStatus
Enumerations of the type for live transcription status.
PhoneStatus
Status of telephone. Here are more detailed structural descriptions.
PhoneFailedReason
The reason for the failure of the telephone call. Here are more detailed structural descriptions.
Cloud recording helper interface.
ZoomVideoSDKSubSessionStatus
Enumerations of subsession statuses.
ZoomVideoSDKUserHelpRequestResult
Enumerations of subsession user help request results.
Vector container interface.