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"
#if defined(WIN32)
class IZoomRealNameAuthMeetingHelper;
#endif
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_UNKNOWN,
    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,
};
 
enum MeetingFailCode
{
    MEETING_SUCCESS                         = 0,
    MEETING_FAIL_CONNECTION_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, 
    MEETING_FAIL_HOST_DISALLOW_OUTSIDE_USER_JOIN = 62,   
    MEETING_FAIL_UNABLE_TO_JOIN_EXTERNAL_MEETING = 63,  
    MEETING_FAIL_BLOCKED_BY_ACCOUNT_ADMIN = 64,  
    MEETING_FAIL_NEED_SIGN_IN_FOR_PRIVATE_MEETING = 82,  
    MEETING_FAIL_NEED_CONFIRM_PLINK = 88,
    MEETING_FAIL_NEED_INPUT_PLINK = 89,
    MEETING_FAIL_APP_PRIVILEGE_TOKEN_ERROR = 500,  
    MEETING_FAIL_AUTHORIZED_USER_NOT_INMEETING = 501,
    MEETING_FAIL_ON_BEHALF_TOKEN_CONFLICT_LOGIN_ERROR = 502,
    MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH = 1143, 
    MEETING_FAIL_UNKNOWN = 0xffff,
 
};  
 
enum MeetingEndReason
{
    EndMeetingReason_None = 0,
    EndMeetingReason_KickByHost = 1,
    EndMeetingReason_EndByHost = 2,
    EndMeetingReason_JBHTimeOut = 3,
    EndMeetingReason_NoAttendee = 4,
    EndMeetingReason_HostStartAnotherMeeting = 5,
    EndMeetingReason_FreeMeetingTimeOut = 6,
    EndMeetingReason_Undefined = 7,
    /* Authorized user left. */
    EndMeetingReason_DueToAuthorizedUserLeave = 8,
};
 
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,
};
 
enum AudioRawdataSamplingRate
{
    AudioRawdataSamplingRate_32K, 
    AudioRawdataSamplingRate_48K, 
};
 
enum VideoRawdataColorspace
{
    VideoRawdataColorspace_BT601_L,
    VideoRawdataColorspace_BT601_F,
    VideoRawdataColorspace_BT709_L,
    VideoRawdataColorspace_BT709_F
};
 
typedef struct tagJoinParam4WithoutLogin
{
    UINT64         meetingNumber;
    const zchar_t* vanityID;
    const zchar_t* userName;
    const zchar_t* psw;
    const zchar_t* app_privilege_token; 
    const zchar_t* userZAK;
    const zchar_t* customer_key;
    const zchar_t* webinarToken;
    bool           isVideoOff;
    bool           isAudioOff;
    const zchar_t* join_token;
    const zchar_t* onBehalfToken;
    bool           isMyVoiceInMix; 
#if defined(WIN32)
    HWND           hDirectShareAppWnd;
    bool           isDirectShareDesktop;
#endif
    bool           isAudioRawDataStereo; 
    AudioRawdataSamplingRate eAudioRawdataSamplingRate; 
    VideoRawdataColorspace eVideoRawdataColorspace;
}JoinParam4WithoutLogin;
 
typedef struct tagJoinParam4NormalUser
{
    UINT64         meetingNumber;
    const zchar_t* vanityID;
    const zchar_t* userName;
    const zchar_t* psw;
    const zchar_t* app_privilege_token; 
    const zchar_t* customer_key;
    const zchar_t* webinarToken;
    bool           isVideoOff;
    bool           isAudioOff;
    const zchar_t* join_token;
    bool           isMyVoiceInMix;
#if defined(WIN32)
    HWND           hDirectShareAppWnd;
    bool           isDirectShareDesktop;
#endif
    bool           isAudioRawDataStereo; 
    AudioRawdataSamplingRate eAudioRawdataSamplingRate;
    VideoRawdataColorspace eVideoRawdataColorspace;
    
}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 zchar_t* userZAK;
    const zchar_t* userName;
    ZoomUserType   zoomuserType;
    UINT64         meetingNumber;
    const zchar_t* vanityID;
    const zchar_t* customer_key;
    bool           isVideoOff;
    bool           isAudioOff;
    bool           isMyVoiceInMix; 
#if defined(WIN32)
    HWND           hDirectShareAppWnd;
    bool           isDirectShareDesktop;
#endif
    bool           isAudioRawDataStereo; 
    AudioRawdataSamplingRate eAudioRawdataSamplingRate; 
    VideoRawdataColorspace eVideoRawdataColorspace;
}StartParam4WithoutLogin;
 
typedef struct tagStartParam4NormalUser
{
    UINT64          meetingNumber;
    const zchar_t*  vanityID;
    const zchar_t*  customer_key;
    bool            isVideoOff;
    bool            isAudioOff;
    bool            isMyVoiceInMix; 
#if defined(WIN32)
    HWND            hDirectShareAppWnd;
    bool            isDirectShareDesktop;
#endif
    bool            isAudioRawDataStereo; 
    AudioRawdataSamplingRate eAudioRawdataSamplingRate;
    VideoRawdataColorspace eVideoRawdataColorspace;
}StartParam4NormalUser;
 
 
typedef struct tagStartParam
{
    SDKUserType userType;
    const zchar_t* inviteContactId;
    union 
    {
        StartParam4NormalUser normaluserStart;
        StartParam4WithoutLogin withoutloginStart;
    }param;    
    tagStartParam()
    {
        userType = SDK_UT_WITHOUT_LOGIN;
        inviteContactId = nullptr;
        memset(&param, 0, sizeof(param));  
    }
}StartParam;
 
enum ConnectionQuality 
{
    Conn_Quality_Unknown,
    Conn_Quality_Very_Bad,
    Conn_Quality_Bad,
    Conn_Quality_Not_Good,
    Conn_Quality_Normal,
    Conn_Quality_Good,
    Conn_Quality_Excellent,
};
 
enum MeetingComponentType
{
    MeetingComponentType_Def = 0,
    MeetingComponentType_AUDIO,
    MeetingComponentType_VIDEO,
    MeetingComponentType_SHARE,
};
 
typedef struct tagMeetingAudioStatisticInfo
{
    int   sendFrequency;
    int   sendBandwidth;
    int   sendRTT;
    int   sendJitter;
    float sendPacketLossAvg;
    float sendPacketLossMax;
 
    int   recvFrequency;
    int   recvBandwidth;
    int   recvRTT;
    int   recvJitter;
    float recvPacketLossAvg;
    float recvPacketLossMax;
 
    tagMeetingAudioStatisticInfo()
    {
        sendFrequency = 0;
        sendBandwidth = 0;
        sendRTT = 0;
        sendJitter = 0;
        sendPacketLossAvg = 0;
        sendPacketLossMax = 0;
        recvFrequency = 0;
        recvBandwidth = 0;
        recvRTT = 0;
        recvJitter = 0;
        recvPacketLossAvg = 0;
        recvPacketLossMax = 0;
        
    }
}MeetingAudioStatisticInfo;
 
typedef struct tagMeetingASVStatisticInfo
{
    int   sendBandwidth;
    int   sendFps;
    int   sendRTT;
    int   sendJitter;
    int   sendResolution;
    float sendPacketLossAvg;
    float sendPacketLossMax;
 
    int   recvBandwidth;
    int   recvFps;
    int   recvRTT;
    int   recvJitter;
    int   recvResolution;
    float recvPacketLossAvg;
    float recvPacketLossMax;
 
    tagMeetingASVStatisticInfo()
    {
        sendFps = 0;
        sendBandwidth = 0;
        sendRTT = 0;
        sendJitter = 0;
        sendResolution = 0;
        sendPacketLossAvg = 0;
        sendPacketLossMax = 0;
        recvFps = 0;
        recvBandwidth = 0;
        recvRTT = 0;
        recvJitter = 0;
        recvResolution = 0;
        recvPacketLossAvg = 0;
        recvPacketLossMax = 0;
    }
}MeetingASVStatisticInfo;
 
#if defined(WIN32)
enum SDKViewType
{
    SDK_FIRST_VIEW,
    SDK_SECOND_VIEW,
    
    SDK_SEND_SHARE_VIEW,
};
 
enum SDKShareViewZoomRatio
{
    SDK_ShareViewZoomRatio_50,
    SDK_ShareViewZoomRatio_100,
    SDK_ShareViewZoomRatio_150,
    SDK_ShareViewZoomRatio_200,
    SDK_ShareViewZoomRatio_300
};
#endif
enum InMeetingSupportAudioType
{
    AUDIO_TYPE_NONE = 0,
    AUDIO_TYPE_VOIP = 1,
    AUDIO_TYPE_TELEPHONY = 1 << 1
};
 
 
enum MeetingConnType
{
    Meeting_Conn_None,
    Meeting_Conn_Normal,
    Meeting_Conn_FailOver,
};
 
class IMeetingInfo
{
public:
    virtual UINT64 GetMeetingNumber() = 0;
    
    virtual const zchar_t* GetMeetingID() = 0;
    
    virtual const zchar_t* GetMeetingTopic() = 0;
    
    virtual const zchar_t* GetMeetingPassword() = 0;
    
    virtual MeetingType GetMeetingType() = 0;
    
    virtual const zchar_t* GetInviteEmailTemplate() = 0;
    
    virtual const zchar_t* GetInviteEmailTitle() = 0;
    
    virtual const zchar_t* GetJoinMeetingUrl() = 0;
    
    virtual const zchar_t* GetMeetingHostTag() = 0;
    
    virtual MeetingConnType GetMeetingConnType() = 0;
    
    virtual int GetSupportedMeetingAudioType() = 0;
 
    virtual ~IMeetingInfo(){};
};
 
typedef struct tagMeetingParameter
{
    MeetingType meeting_type;
    bool is_view_only;
    bool is_auto_recording_local;
    bool is_auto_recording_cloud;
    UINT64 meeting_number;
    const zchar_t* meeting_topic;
    const zchar_t* meeting_host;
    tagMeetingParameter()
    {
        meeting_type = MEETING_TYPE_NONE;
        is_view_only = true;
        is_auto_recording_local = false;
        is_auto_recording_cloud = false;
        meeting_number = 0;
        meeting_topic = nullptr;
        meeting_host = nullptr;
    }
 
    ~tagMeetingParameter()
    {
        if (meeting_host)
        {
            delete[] meeting_host;
            meeting_host = nullptr;
        }
        if (meeting_topic)
        {
            delete[] meeting_topic;
            meeting_topic = nullptr;
        }
    }
}MeetingParameter;
 
enum StatisticsWarningType
{
    Statistics_Warning_None,
    Statistics_Warning_Network_Quality_Bad,
    Statistics_Warning_Busy_System,
};
 
#if defined(WIN32)
class IMeetingAppSignalHandler
{
public:
    virtual ~IMeetingAppSignalHandler() {};
 
    virtual bool CanShowPanel() = 0;
    virtual SDKError ShowPanel(unsigned int x, unsigned int y) = 0;
    virtual SDKError HidePanel() = 0;
};
#endif
 
class IMeetingServiceEvent
{
public:
    virtual ~IMeetingServiceEvent() {}
    virtual void onMeetingStatusChanged(MeetingStatus status, int iResult = 0) = 0;
    
    virtual void onMeetingStatisticsWarningNotification(StatisticsWarningType type) = 0;
    
    virtual void onMeetingParameterNotification(const MeetingParameter* meeting_param) = 0;
    
    virtual void onSuspendParticipantsActivities() = 0;
    
    virtual void onAICompanionActiveChangeNotice(bool bActive) = 0;
    
    virtual void onMeetingTopicChanged(const zchar_t* sTopic) = 0;
    
    virtual void onMeetingFullToWatchLiveStream(const zchar_t* sLiveStreamUrl) = 0;
 
    virtual void onUserNetworkStatusChanged(MeetingComponentType type, ConnectionQuality level, unsigned int userId, bool uplink) = 0;
 
#if defined(WIN32)
    virtual void onAppSignalPanelUpdated(IMeetingAppSignalHandler* pHandler) = 0;
#endif
};
 
class IListFactory {
public:
    virtual ~IListFactory() {}
 
    virtual IList<GrantCoOwnerAssetsInfo>* CreateAssetsInfoList() = 0;
    virtual void DestroyAssetsInfoList(IList<GrantCoOwnerAssetsInfo>* list) = 0;
};  
#if defined(WIN32)
class IAnnotationController;
class IMeetingBreakoutRoomsController;
class IMeetingH323Helper;
class IMeetingPhoneHelper;
class IMeetingRemoteController;
class IMeetingUIController;
class IMeetingLiveStreamController;
class IClosedCaptionController;
class IMeetingQAController;
class IMeetingInterpretationController;
class IMeetingSignInterpretationController;
class IEmojiReactionController;
class IMeetingAANController;
class ICustomImmersiveController;
class IMeetingPollingController;
class IMeetingIndicatorController;
class IMeetingProductionStudioController;
#endif
class IMeetingConfiguration;
class IMeetingBOController;
class IMeetingChatController;
class IMeetingAudioController;
class IMeetingParticipantsController;
class IMeetingRecordingController;
class IMeetingShareController;
class IMeetingVideoController;
class IMeetingWaitingRoomController;
class IMeetingWebinarController;
class IMeetingRawArchivingController;
class IMeetingReminderController;
class IMeetingWhiteboardController;
class IMeetingSmartSummaryController;
class IMeetingEncryptionController;
class IMeetingRemoteSupportController;
class IMeetingAICompanionController;
class IMeetingDocsController;
class IMeetingService
{
public:
    virtual SDKError SetEvent(IMeetingServiceEvent* pEvent) = 0;
    
    virtual SDKError HandleZoomWebUriProtocolAction(const zchar_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 bool CanSetMeetingTopic() = 0;
    
    virtual SDKError SetMeetingTopic(const zchar_t* sTopic) = 0;
    
    virtual SDKError SuspendParticipantsActivities() = 0;
    
    virtual bool CanSuspendParticipantsActivities() = 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 SDKError GetMeetingAudioStatisticInfo(MeetingAudioStatisticInfo& info) = 0;
 
    virtual SDKError GetMeetingVideoStatisticInfo(MeetingASVStatisticInfo& info) = 0;
 
    virtual SDKError GetMeetingShareStatisticInfo(MeetingASVStatisticInfo& info) = 0;
    
    virtual IMeetingVideoController* GetMeetingVideoController() = 0;
    
    virtual IMeetingShareController* GetMeetingShareController() = 0;
    
    virtual IMeetingAudioController* GetMeetingAudioController() = 0;
    
    virtual IMeetingRecordingController* GetMeetingRecordingController() = 0;
    
    virtual IMeetingWaitingRoomController* GetMeetingWaitingRoomController() = 0;
    
    virtual IMeetingParticipantsController* GetMeetingParticipantsController() = 0;
    
    virtual IMeetingWebinarController* GetMeetingWebinarController() = 0;
    
    virtual IMeetingRawArchivingController* GetMeetingRawArchivingController() = 0;
    
    virtual IMeetingReminderController* GetMeetingReminderController() = 0;
    
    virtual IMeetingSmartSummaryController* GetMeetingSmartSummaryController() = 0;
    
    virtual IMeetingChatController* GetMeetingChatController() = 0;
    
    virtual IMeetingBOController* GetMeetingBOController() = 0;
    
    virtual IMeetingConfiguration* GetMeetingConfiguration() = 0;
    
    virtual IMeetingAICompanionController* GetMeetingAICompanionController() = 0;
    
#if defined(WIN32)
    virtual IMeetingUIController* GetUIController() = 0;
    
    virtual IAnnotationController* GetAnnotationController() = 0;
    
    virtual IMeetingRemoteController* GetMeetingRemoteController() = 0;
    
    virtual IMeetingH323Helper* GetH323Helper() = 0;
    
    virtual IMeetingPhoneHelper* GetMeetingPhoneHelper() = 0;
    
    virtual IMeetingLiveStreamController* GetMeetingLiveStreamController() = 0;
    
    virtual IClosedCaptionController* GetMeetingClosedCaptionController() = 0;
    
    virtual IZoomRealNameAuthMeetingHelper* GetMeetingRealNameAuthController() = 0;
    
    virtual IMeetingQAController* GetMeetingQAController() = 0;
    
    virtual IMeetingInterpretationController* GetMeetingInterpretationController() = 0;
    
    virtual IMeetingSignInterpretationController* GetMeetingSignInterpretationController() = 0;
    
    virtual IEmojiReactionController* GetMeetingEmojiReactionController() = 0;
    
    virtual IMeetingAANController* GetMeetingAANController() = 0;
    
    virtual ICustomImmersiveController* GetMeetingImmersiveController() = 0;
    
    virtual IMeetingWhiteboardController* GetMeetingWhiteboardController() = 0;
    
    virtual IMeetingDocsController* GetMeetingDocsController() = 0;
    
    virtual IMeetingPollingController* GetMeetingPollingController() = 0;
    
    virtual IMeetingRemoteSupportController* GetMeetingRemoteSupportController() = 0;
    
    virtual IMeetingIndicatorController* GetMeetingIndicatorController() = 0;
    
    virtual IMeetingProductionStudioController* GetMeetingProductionStudioController() = 0;
#endif
    virtual const zchar_t* GetInMeetingDataCenterInfo() = 0;
    
    virtual IMeetingEncryptionController* GetInMeetingEncryptionController() = 0;
 
     virtual IListFactory* GetListFactory() = 0;
};
END_ZOOM_SDK_NAMESPACE
#endif