meeting_service_interface.h

Go to the documentation of this file.

#ifndef _MEETING_SERVICE_INTERFACE_H_
#define _MEETING_SERVICE_INTERFACE_H_
#include "zoom_sdk_def.h"
class IZoomRealNameAuthMeetingHelper;

BEGIN_ZOOM_SDK_NAMESPACE
enum MeetingStatus
{
    MEETING_STATUS_IDLE,
    MEETING_STATUS_CONNECTING,
    MEETING_STATUS_WAITINGFORHOST,
    MEETING_STATUS_INMEETING,
    MEETING_STATUS_DISCONNECTING,
    MEETING_STATUS_RECONNECTING,
    MEETING_STATUS_FAILED,
    MEETING_STATUS_ENDED,
    MEETING_STATUS_UNKNOW,
    MEETING_STATUS_LOCKED,
    MEETING_STATUS_UNLOCKED,
    MEETING_STATUS_IN_WAITING_ROOM,
    MEETING_STATUS_WEBINAR_PROMOTE,
    MEETING_STATUS_WEBINAR_DEPROMOTE,
    MEETING_STATUS_JOIN_BREAKOUT_ROOM,
    MEETING_STATUS_LEAVE_BREAKOUT_ROOM,
    MEETING_STATUS_WAITING_EXTERNAL_SESSION_KEY,
};

enum MeetingFailCode
{
    MEETING_SUCCESS                         = 0,
    MEETING_FAIL_NETWORK_ERR                = 1,
    MEETING_FAIL_RECONNECT_ERR              = 2,
    MEETING_FAIL_MMR_ERR                    = 3,
    MEETING_FAIL_PASSWORD_ERR               = 4,
    MEETING_FAIL_SESSION_ERR                = 5,
    MEETING_FAIL_MEETING_OVER               = 6,
    MEETING_FAIL_MEETING_NOT_START          = 7,
    MEETING_FAIL_MEETING_NOT_EXIST          = 8,
    MEETING_FAIL_MEETING_USER_FULL          = 9,
    MEETING_FAIL_CLIENT_INCOMPATIBLE        = 10,
    MEETING_FAIL_NO_MMR                     = 11,
    MEETING_FAIL_CONFLOCKED                 = 12,
    MEETING_FAIL_MEETING_RESTRICTED         = 13,
    MEETING_FAIL_MEETING_RESTRICTED_JBH     = 14,
    MEETING_FAIL_CANNOT_EMIT_WEBREQUEST     = 15,
    MEETING_FAIL_CANNOT_START_TOKENEXPIRE   = 16,
    SESSION_VIDEO_ERR                       = 17,
    SESSION_AUDIO_AUTOSTARTERR              = 18,
    MEETING_FAIL_REGISTERWEBINAR_FULL       = 19,
    MEETING_FAIL_REGISTERWEBINAR_HOSTREGISTER       = 20,
    MEETING_FAIL_REGISTERWEBINAR_PANELISTREGISTER   = 21,
    MEETING_FAIL_REGISTERWEBINAR_DENIED_EMAIL       = 22,
    MEETING_FAIL_ENFORCE_LOGIN      = 23,
    CONF_FAIL_ZC_CERTIFICATE_CHANGED        = 24,  
    CONF_FAIL_VANITY_NOT_EXIST              = 27, 
    CONF_FAIL_JOIN_WEBINAR_WITHSAMEEMAIL        = 28, 
    CONF_FAIL_DISALLOW_HOST_MEETING     = 29, 
    MEETING_FAIL_WRITE_CONFIG_FILE          = 50,   
    MEETING_FAIL_FORBID_TO_JOIN_INTERNAL_MEETING = 60, 
    CONF_FAIL_REMOVED_BY_HOST = 61, 
};  

enum MeetingEndReason
{
    EndMeetingReason_None = 0,
    EndMeetingReason_KickByHost = 1,
    EndMeetingReason_EndByHost = 2,
    EndMeetingReason_JBHTimeOut = 3,
    EndMeetingReason_NoAttendee = 4,
    EndMeetingReason_HostStartAnotherMeeting = 5,
    EndMeetingReason_FreeMeetingTimeOut = 6,
    EndMeetingReason_NetworkBroken,
};

enum MeetingType
{
    MEETING_TYPE_NONE,
    MEETING_TYPE_NORMAL,
    MEETING_TYPE_WEBINAR,
    MEETING_TYPE_BREAKOUTROOM,
};

enum LeaveMeetingCmd
{
    LEAVE_MEETING,
    END_MEETING,
};

enum SDKUserType
{
    SDK_UT_NORMALUSER = 100,
    SDK_UT_WITHOUT_LOGIN,
};

typedef struct tagJoinParam4WithoutLogin
{
    UINT64         meetingNumber;
    const wchar_t* vanityID;
    const wchar_t* userName;
    const wchar_t* psw;
    HWND           hDirectShareAppWnd;
    const wchar_t* userZAK;
    const wchar_t* participantId;
    const wchar_t* webinarToken;
    bool           isDirectShareDesktop;
    bool           isVideoOff;
    bool           isAudioOff;
}JoinParam4WithoutLogin;

typedef struct tagJoinParam4NormalUser
{
    UINT64         meetingNumber;
    const wchar_t* vanityID;
    const wchar_t* userName;
    const wchar_t* psw;
    HWND           hDirectShareAppWnd;
    const wchar_t* participantId;
    const wchar_t* webinarToken;
    bool           isVideoOff;
    bool           isAudioOff;
    bool           isDirectShareDesktop;
}JoinParam4NormalUser;

typedef struct tagJoinParam
{
    SDKUserType userType;
    union 
    {
        JoinParam4NormalUser normaluserJoin;
        JoinParam4WithoutLogin withoutloginuserJoin;
    } param;    
    tagJoinParam()
    {
        userType = SDK_UT_WITHOUT_LOGIN;
        memset(&param, 0, sizeof(param));
    }
}JoinParam;


enum ZoomUserType
{
    ZoomUserType_APIUSER,
    ZoomUserType_EMAIL_LOGIN,
    ZoomUserType_FACEBOOK,
    ZoomUserType_GoogleOAuth,
    ZoomUserType_SSO,
    ZoomUserType_Unknown,
};

typedef struct tagStartParam4WithoutLogin
{
    const wchar_t* userID;
    const wchar_t* userZAK;
    const wchar_t* userName;
    ZoomUserType   zoomuserType;
    UINT64         meetingNumber;
    const wchar_t* vanityID;
    HWND           hDirectShareAppWnd;
    const wchar_t* participantId;
    bool           isDirectShareDesktop;
    bool           isVideoOff;
    bool           isAudioOff;
}StartParam4WithoutLogin;

typedef struct tagStartParam4NormalUser
{
    UINT64          meetingNumber;
    const wchar_t*  vanityID;
    HWND            hDirectShareAppWnd;
    const wchar_t*  participantId;
    bool            isVideoOff;
    bool            isAudioOff;
    bool            isDirectShareDesktop;
}StartParam4NormalUser;


typedef struct tagStartParam
{
    SDKUserType userType;
    union 
    {
        StartParam4NormalUser normaluserStart;
        StartParam4WithoutLogin withoutloginStart;
    }param;    
    tagStartParam()
    {
        userType = SDK_UT_WITHOUT_LOGIN;
        memset(&param, 0, sizeof(param));
    }
}StartParam;

enum ConnectionQuality 
{
    Conn_Quality_Unknow,
    Conn_Quality_Very_Bad,
    Conn_Quality_Bad,
    Conn_Quality_Not_Good,
    Conn_Quality_Normal,
    Conn_Quality_Good,
    Conn_Quality_Excellent,
};

enum SDKViewType
{
    SDK_FIRST_VIEW,
    SDK_SECOND_VIEW,
};

enum MeetingConnType
{
    Meeting_Conn_None,
    Meeting_Conn_Normal,
    Meeting_Conn_FailOver,
};

class IMeetingInfo
{
public:
    virtual UINT64 GetMeetingNumber() = 0;

    virtual const wchar_t* GetMeetingID() = 0;
    
    virtual const wchar_t* GetMeetingTopic() = 0;

    virtual const wchar_t* GetMeetingPassword() = 0;

    virtual MeetingType GetMeetingType() = 0;

    virtual const wchar_t* GetInviteEmailTeamplate() = 0;

    virtual const wchar_t* GetInviteEmailTitle() = 0;

    virtual const wchar_t* GetJoinMeetingUrl() = 0;

    virtual const wchar_t* GetMeetingHostTag() = 0;

    virtual bool IsInternalMeeting() = 0;

    virtual MeetingConnType GetMeetingConnType() = 0;

    virtual ~IMeetingInfo(){};
};

typedef struct tagMeetingParameter
{
    MeetingType meeting_type;
    bool is_view_only;
    UINT64 meeting_number;
    const wchar_t* meeting_topic;
    const wchar_t* meeting_host;
    tagMeetingParameter()
    {
        meeting_type = MEETING_TYPE_NONE;
        is_view_only = true;
        meeting_number = 0;
        meeting_topic = NULL;
        meeting_host = NULL;
    }

    ~tagMeetingParameter()
    {
        if (meeting_host)
        {
            delete[] meeting_host;
            meeting_host = NULL;
        }
        if (meeting_topic)
        {
            delete[] meeting_topic;
            meeting_topic = NULL;
        }
    }
}MeetingParameter;

class IMeetingExternalSecureKeyHandler
{
public:
    virtual void SetChatSessionKey(const char* key, int key_len, const char* iv, int iv_len) = 0;
    
    virtual void SetFileTransferSessionKey(const char* key, int key_len, const char* iv, int iv_len) = 0;

    virtual void SetAudioSessionKey(const char* key, int key_len, const char* iv, int iv_len) = 0;

    virtual void SetVideoSessionKey(const char* key, int key_len, const char* iv, int iv_len) = 0;

    virtual void SetShareSessionKey(const char* key, int key_len, const char* iv, int iv_len) = 0;

    virtual void Cancel() = 0;

    virtual void Confirm() = 0;

    virtual ~IMeetingExternalSecureKeyHandler() {};
};

enum StatisticsWarningType
{
    Statistics_Warning_None,
    Statistics_Warning_Network_Quality_Bad,
    Statistics_Warning_Busy_System,
};

enum OSSessionType
{
    OS_SessionType_NotHandle = 0,
    OS_SessionType_Lock, 
    OS_SessionType_Logoff,
    OS_SessionType_Remote_DISCONNECT,
};
class IMeetingServiceEvent
{
public:
    virtual void onMeetingStatusChanged(MeetingStatus status, int iResult = 0) = 0;

    virtual void onMeetingStatisticsWarningNotification(StatisticsWarningType type) = 0;
    
    virtual void onMeetingSecureKeyNotification(const char* key, int len, IMeetingExternalSecureKeyHandler* pHandler) = 0;

    virtual void onMeetingParameterNotification(const MeetingParameter* meeting_param) = 0;
};

class IAnnotationController;
class IMeetingAudioController;
class IMeetingBreakoutRoomsController;
class IMeetingChatController;
class IMeetingConfiguration;
class IMeetingH323Helper;
class IMeetingParticipantsController;
class IMeetingPhoneHelper;
class IMeetingRecordingController;
class IMeetingRemoteController;
class IMeetingShareController;
class IMeetingUIController;
class IMeetingVideoController;
class IMeetingWaitingRoomController;
class IMeetingLiveStreamController;
class IMeetingWebinarController;
class IClosedCaptionController;
class IMeetingQAController;
class IMeetingBOController;
class IMeetingInterpretationController;
class IMeetingService
{
public:
    virtual SDKError SetEvent(IMeetingServiceEvent* pEvent) = 0;

    virtual SDKError HandleZoomWebUriProtocolAction(const wchar_t* protocol_action) = 0;

    virtual SDKError Join(JoinParam& joinParam) = 0;

    virtual SDKError Start(StartParam& startParam) = 0;

    virtual SDKError Leave(LeaveMeetingCmd leaveCmd) = 0;

    virtual MeetingStatus GetMeetingStatus() = 0;
    
    virtual SDKError LockMeeting() = 0;

    virtual SDKError UnlockMeeting() = 0;

    virtual bool IsMeetingLocked() = 0;

    virtual IMeetingInfo* GetMeetingInfo() = 0;

    virtual ConnectionQuality GetSharingConnQuality(bool bSending = true) = 0;

    virtual ConnectionQuality GetVideoConnQuality(bool bSending = true) = 0;

    virtual ConnectionQuality GetAudioConnQuality(bool bSending = true) = 0;

    virtual IMeetingConfiguration* GetMeetingConfiguration() = 0;

    virtual IMeetingUIController* GetUIController() = 0;

    virtual IAnnotationController* GetAnnotationController() = 0;

    virtual IMeetingVideoController* GetMeetingVideoController() = 0;

    virtual IMeetingRemoteController* GetMeetingRemoteController() = 0;

    virtual IMeetingShareController* GetMeetingShareController() = 0;

    virtual IMeetingAudioController* GetMeetingAudioController() = 0;

    virtual IMeetingRecordingController* GetMeetingRecordingController() = 0;

    virtual IMeetingChatController* GetMeetingChatController() = 0;

    virtual IMeetingWaitingRoomController* GetMeetingWaitingRoomController() = 0;
    
    virtual IMeetingH323Helper* GetH323Helper() = 0;

    virtual IMeetingPhoneHelper* GetMeetingPhoneHelper() = 0;

    virtual IMeetingBreakoutRoomsController* GetMeetingBreakoutRoomsController() = 0;

    virtual IMeetingParticipantsController* GetMeetingParticipantsController() = 0;

    virtual IMeetingLiveStreamController* GetMeetingLiveStreamController() = 0;

    virtual IMeetingWebinarController* GetMeetingWebinarController() = 0;

    virtual IClosedCaptionController* GetMeetingClosedCaptionController() = 0;

    virtual IZoomRealNameAuthMeetingHelper* GetMeetingRealNameAuthController() = 0;

    virtual IMeetingQAController* GetMeetingQAController() = 0;

    virtual IMeetingBOController* GetMeetingBOController() = 0;

    virtual IMeetingInterpretationController* GetMeetingInterpretationController() = 0;

};
END_ZOOM_SDK_NAMESPACE
#endif