zoom_video_sdk_delegate_interface.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_DELEGATE_INTERFACE_H_
#define _ZOOM_VIDEO_SDK_DELEGATE_INTERFACE_H_
#include "zoom_video_sdk_def.h"
#include "zoom_video_sdk_vector_interface.h"
#include "helpers/zoom_video_sdk_phone_helper_interface.h"
#include "helpers/zoom_video_sdk_recording_helper_interface.h"
#include "helpers/zoom_video_sdk_audio_setting_interface.h"
#include "helpers/zoom_video_sdk_user_helper_interface.h"
#include "helpers/zoom_video_sdk_video_helper_interface.h"
#include "helpers/zoom_video_sdk_audio_helper_interface.h"
#include "helpers/zoom_video_sdk_share_helper_interface.h"
#include "helpers/zoom_video_sdk_livestream_helper_interface.h"
#include "helpers/zoom_video_sdk_livetranscription_helper_interface.h"
#include "helpers/zoom_video_sdk_chat_helper_interface.h"
#include "helpers/zoom_video_sdk_network_connection_helper_interface.h"
#include "helpers/zoom_video_sdk_crc_helper_interface.h"
#include "helpers/zoom_video_sdk_subsession_interface.h"
#include "helpers/zoom_video_sdk_broadcast_streaming_controller_interface.h"
#include "helpers/zoom_video_sdk_broadcast_streaming_viewer_interface.h"
#include "helpers/zoom_video_sdk_emoji_reaction_helper_interface.h"
#include "helpers/zoom_video_sdk_whiteboard_helper_interface.h"
#if !defined (__linux) || defined ANDROID
#include "helpers/zoom_video_sdk_rtms_helper_interface.h"
#include "helpers/zoom_video_sdk_annotation_helper_interface.h"
#endif
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
class IZoomVideoSDKChatMessage;
class IZoomVideoSDKPasswordHandler;
class IZoomVideoSDKRecordingConsentHandler;
class IZoomVideoSDKCameraControlRequestHandler;
class IZoomVideoSDKRemoteControlRequestHandler;
class IZoomVideoSDKDelegate
{
public:
    virtual void onSessionJoin() = 0;
    
    virtual void onSessionLeave() = 0;
    
    virtual void onSessionLeave(ZoomVideoSDKSessionLeaveReason eReason) = 0;
    
    virtual void onError(ZoomVideoSDKErrors errorCode, int detailErrorCode) = 0;
    
    virtual void onUserJoin(IZoomVideoSDKUserHelper* pUserHelper, IVideoSDKVector<IZoomVideoSDKUser*>* userList) = 0;
    
    virtual void onUserLeave(IZoomVideoSDKUserHelper* pUserHelper, IVideoSDKVector<IZoomVideoSDKUser*>* userList) = 0;
    
    virtual void onUserVideoStatusChanged(IZoomVideoSDKVideoHelper* pVideoHelper, IVideoSDKVector<IZoomVideoSDKUser*>* userList) = 0;
    
    virtual void onUserAudioStatusChanged(IZoomVideoSDKAudioHelper* pAudioHelper, IVideoSDKVector<IZoomVideoSDKUser*>* userList) = 0;
    
    virtual void onUserShareStatusChanged(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;

    virtual void onShareContentChanged(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;

    virtual void onFailedToStartShare(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser) = 0;
    
    virtual void onShareSettingChanged(ZoomVideoSDKShareSetting setting) = 0;
    
    virtual void onUserRecordingConsent(IZoomVideoSDKUser* pUser) = 0;
    
    virtual void onLiveStreamStatusChanged(IZoomVideoSDKLiveStreamHelper* pLiveStreamHelper, ZoomVideoSDKLiveStreamStatus status) = 0;
    
    virtual void onChatNewMessageNotify(IZoomVideoSDKChatHelper* pChatHelper, IZoomVideoSDKChatMessage* messageItem) = 0;
    
    virtual void onUserHostChanged(IZoomVideoSDKUserHelper* pUserHelper, IZoomVideoSDKUser* pUser) = 0;
    
    virtual void onUserActiveAudioChanged(IZoomVideoSDKAudioHelper* pAudioHelper, IVideoSDKVector<IZoomVideoSDKUser*>* list) = 0;
    
    virtual void onSessionNeedPassword(IZoomVideoSDKPasswordHandler* handler) = 0;
    
    virtual void onSessionPasswordWrong(IZoomVideoSDKPasswordHandler* handler) = 0;
    
    virtual void onMixedAudioRawDataReceived(AudioRawData* data_) = 0;

    virtual void onOneWayAudioRawDataReceived(AudioRawData* data_, IZoomVideoSDKUser* pUser) = 0;

    virtual void onSharedAudioRawDataReceived(AudioRawData* data_) = 0;
    
    virtual void onUserManagerChanged(IZoomVideoSDKUser* pUser) = 0;
    
    virtual void onUserNameChanged(IZoomVideoSDKUser* pUser) = 0;

    virtual void onUserFailoverStatusChanged(IZoomVideoSDKUser* pUser, bool bInFailover) = 0;

    virtual void onCameraControlRequestResult(IZoomVideoSDKUser* pUser, bool isApproved) = 0;

    virtual void onCameraControlRequestReceived(IZoomVideoSDKUser* pUser, 
        ZoomVideoSDKCameraControlRequestType requestType, 
        IZoomVideoSDKCameraControlRequestHandler* pCameraControlRequestHandler) = 0;
 
#if defined(WIN32) || defined(__MACOS__)
    virtual void onRemoteControlStatus(IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction, ZoomVideoSDKRemoteControlStatus status) = 0;

    virtual void onRemoteControlRequestReceived(IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction,
        IZoomVideoSDKRemoteControlRequestHandler* pRemoteControlRequestHandler) = 0;
#endif
 
#if defined(WIN32)
    virtual void onRemoteControlServiceInstallResult(bool bSuccess) = 0;
#endif
    
    virtual void onCommandReceived(IZoomVideoSDKUser* sender, const zchar_t* strCmd) = 0;

    virtual void onCommandChannelConnectResult(bool isSuccess) = 0;
    
    virtual void onInviteByPhoneStatus(PhoneStatus status, PhoneFailedReason reason) = 0;

    virtual void onCalloutJoinSuccess(IZoomVideoSDKUser* pUser, const zchar_t* phoneNumber) = 0;

    virtual void onCloudRecordingStatus(RecordingStatus status, IZoomVideoSDKRecordingConsentHandler* pHandler) = 0;

    virtual void onHostAskUnmute() = 0;

    virtual void onMultiCameraStreamStatusChanged(ZoomVideoSDKMultiCameraStreamStatus status, IZoomVideoSDKUser* pUser, IZoomVideoSDKRawDataPipe* pVideoPipe) = 0;

    virtual void onMicSpeakerVolumeChanged(unsigned int micVolume, unsigned int speakerVolume) = 0;

    virtual void onAudioLevelChanged(unsigned int level, bool bAudioSharing, IZoomVideoSDKUser* pUser) = 0;
    
    virtual void onAudioDeviceStatusChanged(ZoomVideoSDKAudioDeviceType type, ZoomVideoSDKAudioDeviceStatus status) = 0;

    virtual void onTestMicStatusChanged(ZoomVideoSDK_TESTMIC_STATUS status) = 0;

    virtual void onSelectedAudioDeviceChanged() = 0;
    
    virtual void onCameraListChanged() = 0;

    virtual void onLiveTranscriptionStatus(ZoomVideoSDKLiveTranscriptionStatus status) = 0;

    virtual void onOriginalLanguageMsgReceived(ILiveTranscriptionMessageInfo* messageInfo) = 0;

    virtual void onLiveTranscriptionMsgInfoReceived(ILiveTranscriptionMessageInfo* messageInfo) = 0;

    virtual void onLiveTranscriptionMsgError(ILiveTranscriptionLanguage* spokenLanguage, ILiveTranscriptionLanguage* transcriptLanguage) = 0;

    virtual void onSpokenLanguageChanged(ILiveTranscriptionLanguage* spokenLanguage) = 0;

    virtual void onVoiceInterpretationReady() = 0;

    virtual void onChatMsgDeleteNotification(IZoomVideoSDKChatHelper* pChatHelper, const zchar_t* msgID, ZoomVideoSDKChatMessageDeleteType deleteBy) = 0;

    virtual void onChatPrivilegeChanged(IZoomVideoSDKChatHelper* pChatHelper, ZoomVideoSDKChatPrivilegeType privilege) = 0;

    virtual void onSendFileStatus(IZoomVideoSDKSendFile* file, const FileTransferStatus& status) = 0;

    virtual void onReceiveFileStatus(IZoomVideoSDKReceiveFile* file, const FileTransferStatus& status) = 0;

    virtual void onProxyDetectComplete() = 0;

    virtual void onProxySettingNotification(IZoomVideoSDKProxySettingHandler* handler) = 0;

    virtual void onSSLCertVerifiedFailNotification(IZoomVideoSDKSSLCertificateInfo* info) = 0;

    virtual void onUserVideoNetworkStatusChanged(ZoomVideoSDKNetworkStatus status, IZoomVideoSDKUser* pUser) = 0;

    virtual void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus, bool isSendingShare) = 0;

    virtual void onUserNetworkStatusChanged(ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser) = 0;
    
    virtual void onUserOverallNetworkStatusChanged(ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser) = 0;
    
    virtual void onCallCRCDeviceStatusChanged(ZoomVideoSDKCRCCallStatus status) = 0;
 
#if !defined __linux
    virtual void onVideoCanvasSubscribeFail(ZoomVideoSDKSubscribeFailReason fail_reason, IZoomVideoSDKUser* pUser, void* handle) = 0;

    virtual void onShareCanvasSubscribeFail(IZoomVideoSDKUser* pUser, void* handle, IZoomVideoSDKShareAction* pShareAction) = 0;
#endif
    
#if !defined (__linux) || defined ANDROID
    virtual void onAnnotationHelperCleanUp(IZoomVideoSDKAnnotationHelper* helper) = 0;

    virtual void onAnnotationPrivilegeChange(IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;
    
    virtual void onAnnotationHelperActived(void* handle) = 0;

    virtual void onAnnotationToolTypeChanged(IZoomVideoSDKAnnotationHelper* helper, void* handle, ZoomVideoSDKAnnotationToolType toolType) = 0;
#endif
    virtual void onVideoAlphaChannelStatusChanged(bool isAlphaModeOn) = 0;

    virtual void onSpotlightVideoChanged(IZoomVideoSDKVideoHelper* pVideoHelper, IVideoSDKVector<IZoomVideoSDKUser*>* userList) = 0;

    virtual void onBindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;

    virtual void onUnbindIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;

    virtual void onIncomingLiveStreamStatusResponse(bool bSuccess, IVideoSDKVector<IncomingLiveStreamStatus>* pStreamsStatusList) = 0;

    virtual void onStartIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;

    virtual void onStopIncomingLiveStreamResponse(bool bSuccess, const zchar_t* strStreamKeyID) = 0;
    
    virtual void onShareContentSizeChanged(IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;

    virtual void onUnsharingWindowsChanged(IVideoSDKVector<void*>* windowsList, IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;
    
    virtual void onSharingActiveMonitorChanged(IVideoSDKVector<void*>* monitorIDs, IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;
    
    virtual void onSharingProcessWindowsStateChanged(bool isAnyWindowSharing, IZoomVideoSDKShareHelper* pShareHelper, IZoomVideoSDKUser* pUser, IZoomVideoSDKShareAction* pShareAction) = 0;
    
    virtual void onSubSessionStatusChanged(ZoomVideoSDKSubSessionStatus status, IVideoSDKVector<ISubSessionKit*>* pSubSessionKitList) = 0;

    virtual void onSubSessionManagerHandle(IZoomVideoSDKSubSessionManager* pManager) = 0;

    virtual void onSubSessionParticipantHandle(IZoomVideoSDKSubSessionParticipant* pParticipant) = 0;

    virtual void onSubSessionUsersUpdate(ISubSessionKit* pSubSessionKit) = 0;

    virtual void onBroadcastMessageFromMainSession(const zchar_t* sMessage, const zchar_t* sUserName) = 0;

    virtual void onSubSessionUserHelpRequest(ISubSessionUserHelpRequestHandler* pHandler) = 0;

    virtual void onSubSessionUserHelpRequestResult(ZoomVideoSDKUserHelpRequestResult eResult) = 0;

    virtual void onStartBroadcastResponse(bool bSuccess, const zchar_t* channelID) = 0;

    virtual void onStopBroadcastResponse(bool bSuccess) = 0;
    
    virtual void onGetBroadcastControlStatus(bool bSuccess, ZoomVideoSDKBroadcastControlStatus status) = 0;

    virtual void onStreamingJoinStatusChanged(ZoomVideoSDKStreamingJoinStatus status) = 0;

    virtual void onEmojiReactionReceived(IZoomVideoSDKUser* pUser, ZoomVideoSDKEmojiReactionType type) = 0;
 
#if !defined (__linux) || defined ANDROID
    virtual void onWhiteboardExported(ZoomVideoSDKExportFormat format, unsigned char* data, long length) = 0;
 
 

    virtual void onUserWhiteboardShareStatusChanged(IZoomVideoSDKUser* pUser, IZoomVideoSDKWhiteboardHelper* pWhiteboardHelper) = 0;

    virtual void onRealTimeMediaStreamsStatus(RealTimeMediaStreamsStatus status) = 0;

    virtual void onRealTimeMediaStreamsFail(RealTimeMediaStreamsFailReason failReason) = 0;
#endif

    virtual void onCanvasSnapshotTaken(IZoomVideoSDKUser* pUser, bool isShare) = 0;

    virtual void onCanvasSnapshotIncompatible(IZoomVideoSDKUser* pUser) = 0;

    virtual void onQOSStatisticsReceived(const ZoomVideoSDKQOSStatistics& statistics, IZoomVideoSDKUser* pUser) = 0;
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif