meeting_configuration_interface.h

Go to the documentation of this file.

 
#ifndef _MEETING_Configuration_INTERFACE_H_
#define _MEETING_Configuration_INTERFACE_H_
#include "zoom_sdk_def.h"
#if defined(WIN32)
#include "customized_resource_helper_interface.h"
#endif
BEGIN_ZOOM_SDK_NAMESPACE
class IMeetingPasswordAndScreenNameHandler
{
public:
    enum RequiredInfoType
    {
        REQUIRED_INFO_TYPE_NONE,
        REQUIRED_INFO_TYPE_Password, 
        REQUIRED_INFO_TYPE_Password4WrongPassword,
        REQUIRED_INFO_TYPE_PasswordAndScreenName,
        REQUIRED_INFO_TYPE_ScreenName,
        REQUIRED_INFO_TYPE_MeetingIDAndScreenName,
    };
 
    virtual RequiredInfoType GetRequiredInfoType() = 0;
 
    virtual bool InputMeetingPasswordAndScreenName(const zchar_t* meetingPassword, const zchar_t* screenName) = 0;
 
    virtual bool InputMeetingIDAndScreenName(const zchar_t* meetingID, const zchar_t* screenName) = 0;
 
    virtual bool InputMeetingScreenName(const zchar_t* screenName) = 0;
 
    virtual void Cancel() = 0;
    virtual ~IMeetingPasswordAndScreenNameHandler() {};
};
 
class IWebinarNeedRegisterHandler
{
public:
    enum WebinarNeedRegisterType
    {
        WebinarReg_NONE,
        WebinarReg_By_Register_Url,
        WebinarReg_By_Email_and_DisplayName,
    };
 
    virtual WebinarNeedRegisterType GetWebinarNeedRegisterType() = 0;
    virtual ~IWebinarNeedRegisterHandler() {};
};
 
class IWebinarNeedRegisterHandlerByUrl : public IWebinarNeedRegisterHandler
{
public:
    virtual const zchar_t* GetWebinarRegisterUrl() = 0;
 
    virtual void Release() = 0;
    virtual ~IWebinarNeedRegisterHandlerByUrl() {};
};
 
class IWebinarNeedRegisterHandlerByEmail : public IWebinarNeedRegisterHandler
{
public:
    virtual SDKError InputWebinarRegisterEmailAndScreenName(const zchar_t* email, const zchar_t* screenName) = 0;
 
    virtual void Cancel() = 0;
 
    virtual ~IWebinarNeedRegisterHandlerByEmail() {};
};
 
class IWebinarInputScreenNameHandler
{
public:
    virtual SDKError InputName(const zchar_t* screenName) = 0;
 
    virtual SDKError Cancel() = 0;
 
    virtual ~IWebinarInputScreenNameHandler() {};
};
 
class IMeetingInputUserInfoHandler
{
public:
    virtual ~IMeetingInputUserInfoHandler() {};
 
    virtual const zchar_t* GetDefaultDisplayName() = 0;
 
    virtual bool CanModifyDefaultDisplayName() = 0;
 
    virtual bool IsValidEmail(const zchar_t* email) = 0;
 
    virtual SDKError InputUserInfo(const zchar_t* name, const zchar_t* email) = 0;
 
    virtual void Cancel() = 0;
};
 
class IMeetingArchiveConfirmHandler
{
public:
    virtual ~IMeetingArchiveConfirmHandler() {};
 
    virtual const zchar_t* GetArchiveConfirmContent() = 0;
        
    virtual SDKError JoinWithArchive(bool bStartArchive) = 0;
};
 
 
class IMeetingConfirmRecoverHandler
{
public:
    virtual ~IMeetingConfirmRecoverHandler() {};
 
    virtual const zchar_t* GetRecoverMeetingContent() = 0;
 
    virtual SDKError RecoverMeeting(bool bRecover) = 0;
};
 
 
class IEndOtherMeetingToJoinMeetingHandler
{
public:
    virtual bool EndOtherMeeting() = 0;
    
    virtual void Cancel() = 0;
    virtual ~IEndOtherMeetingToJoinMeetingHandler() {};
};
 
class IMeetingConfigurationFreeMeetingEvent
{
 
public:
    enum FreeMeetingNeedUpgradeType
    {
        FreeMeetingNeedUpgradeType_NONE,
        FreeMeetingNeedUpgradeType_BY_ADMIN,
        FreeMeetingNeedUpgradeType_BY_GIFTURL,
    };
    virtual ~IMeetingConfigurationFreeMeetingEvent() {}
    virtual void onFreeMeetingRemainTime(unsigned int leftTime) = 0;
    virtual void onFreeMeetingRemainTimeStopCountDown() = 0;
 
    virtual void onFreeMeetingNeedToUpgrade(FreeMeetingNeedUpgradeType type_, const zchar_t* gift_url) =0;
    
    virtual void onFreeMeetingUpgradeToGiftFreeTrialStart() = 0;
    
    virtual void onFreeMeetingUpgradeToGiftFreeTrialStop() = 0;
    
    virtual void onFreeMeetingUpgradeToProMeeting() = 0;
};
 
class IMeetingConfigurationEvent : public IMeetingConfigurationFreeMeetingEvent
{
public:
    virtual ~IMeetingConfigurationEvent() {}
    virtual void onInputMeetingPasswordAndScreenNameNotification(IMeetingPasswordAndScreenNameHandler* pHandler) = 0;
 
    virtual void onWebinarNeedRegisterNotification(IWebinarNeedRegisterHandler* handler_) = 0;
 
    virtual void onEndOtherMeetingToJoinMeetingNotification(IEndOtherMeetingToJoinMeetingHandler* handler_) = 0;
 
    virtual void onWebinarNeedInputScreenName(IWebinarInputScreenNameHandler* pHandler) = 0;
 
    virtual void onJoinMeetingNeedUserInfo(IMeetingInputUserInfoHandler* pHandler) = 0;
 
    virtual void onUserConfirmToStartArchive(IMeetingArchiveConfirmHandler* pHandler) = 0;
 
    virtual void onUserConfirmRecoverMeeting(IMeetingConfirmRecoverHandler* handler) = 0;
};
#if defined(WIN32)
enum SDKInviteDlgTabPage
{
    SDK_INVITEDLG_TAB_EMAILCONTACT = 0, 
    SDK_INVITEDLG_TAB_PHONECONTACT, 
    SDK_INVITEDLG_TAB_ROOMSYSTEM, 
};
 
enum SDKH323TabPage
{
    SDK_INVITEDLG_H323_DIALIN = 0, 
    SDK_INVITEDLG_H323_CALLOUT, 
};
 
typedef struct tagRedirectWarningMsgOption
{
    bool bRedirectBadNetwork;
    bool bRedirectWarnHighCPU;
    tagRedirectWarningMsgOption()
    {
        bRedirectBadNetwork = false;
        bRedirectWarnHighCPU = false;
    }
 
}RedirectWarningMsgOption;
 
 
typedef struct tagPanelistMenuItemOption
{
    bool bNotShowDowngradePanelist;
    tagPanelistMenuItemOption()
    {
        bNotShowDowngradePanelist = false;
    }
 
}PanelistMenuItemOption;
 
typedef struct tagAttendeeMenuItemOption
{
    bool bNotShowPromoteToPanelist;
    tagAttendeeMenuItemOption()
    {
        bNotShowPromoteToPanelist = false;
    }
 
}AttendeeMenuItemOption;
 
class IMeetingUIElemConfiguration
{
public:
    virtual void SetMeetingUIPos(WndPosition pos) = 0;
 
    virtual void SetFloatVideoPos(WndPosition pos) = 0;
 
    virtual void SetSharingToolbarVisibility(bool bShow) = 0;
 
    virtual void SetBottomFloatToolbarWndVisibility(bool bShow) = 0;
 
    virtual void EnableApproveRemoteControlDlg(bool bEnable) = 0;
 
    virtual void EnableDeclineRemoteControlResponseDlg(bool bEnable) = 0;
 
    virtual void EnableLeaveMeetingOptionForHost(bool bEnable) = 0;
 
    virtual void EnableInviteButtonOnMeetingUI(bool bEnable) = 0;
 
    virtual void EnableVideoButtonOnMeetingUI(bool bEnable) = 0;
 
    virtual void EnableAudioButtonOnMeetingUI(bool bEnable) = 0;
 
    virtual void EnableEnterAndExitFullScreenButtonOnMeetingUI(bool bEnable) = 0;
 
    virtual void EnableLButtonDBClick4SwitchFullScreenMode(bool bEnable) = 0;
 
    virtual void SetFloatVideoWndVisibility(bool bShow) = 0;
 
    virtual void RedirectClickShareBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectClickEndMeetingBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectFreeMeetingEndingReminderDlg(bool bRedirect) = 0;
 
    virtual void RedirectClickCustomLiveStreamMenuEvent(bool bRedirect) = 0;
 
    virtual void RedirectClickParticipantListBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectClickCCBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectMeetingWarningMsg(RedirectWarningMsgOption redirectOption) = 0;
 
    virtual void EnableToolTipsShow(bool bEnable) = 0;
 
    virtual void EnableClaimHostFeature(bool bEnable) = 0;
 
    virtual void EnableAutoHideJoinAudioDialog(bool bEnable) = 0;
 
    virtual void AlwaysShowIconOnTaskBar(bool bAlwaysShow) = 0;
 
    virtual void DisableSplitScreenModeUIElements(bool bDisable) = 0;
 
    virtual void SetShowAudioUseComputerSoundChkbox(bool bShow) = 0;
 
    virtual void SetShowVideoOptimizeChkbox(bool bShow) = 0;
 
    virtual void SetShowCallInTab(bool bShow) = 0;
 
    virtual void SetShowCallMeTab(bool bShow) = 0;
 
    virtual SDKError DisableTopMostAttr4SettingDialog(bool bDisable) = 0;
 
    virtual SDKError EnableGrabShareWithoutReminder(bool bEnable) = 0;
    
    virtual void EnableShowShareSwitchMultiToSingleConfirmDlg(bool bEnable) = 0;
 
    virtual void DisableFreeMeetingRemainTimeNotify(bool bDisable) = 0;
 
    virtual void HideChatItemOnMeetingUI(bool bHide) = 0;
 
    virtual void HideRecordItemOnMeetingUI(bool bHide) = 0;
 
    virtual void HideUpgradeFreeMeetingButton(bool bHide) = 0;
 
    virtual void SetShowInviteDlgTabPage(SDKInviteDlgTabPage tabPage, bool bShow) = 0;
 
    virtual void SetShowH323SubTabPage(SDKH323TabPage tabPage, bool bShow) = 0;
 
 
    // \brief Set the visibility of the local recording convert progress bar dialog. Default: TRUE. 
    virtual void EnableLocalRecordingConvertProgressBarDialog(bool bShow) = 0;
 
    // \brief Set the visibility of Switch Camera button on 2nd camera share window,Default: TRUE. 
    virtual void HideSwitchCameraButton(bool bHide) = 0;
 
    // \brief Set the visibility of CopyURL button on invite window, Default: TRUE. 
    virtual void HideCopyUrlOnInviteWindow(bool bHide) = 0;
 
    // \brief Set the visibility of CopyInvitation button on invite window, Default: TRUE. 
    virtual void HideCopyInvitationOnInviteWindow(bool bHide) = 0;
 
    // \brief Set the visibility of Keypad button on meeting window, Default: TRUE. 
    virtual void HideKeypadButtonOnMeetingWindow(bool bHide) = 0;
 
    virtual void HideRemoteControlOnMeetingUI(bool bHide) = 0;
    
    virtual void HideQAOnMeetingUI(bool bHide) = 0;
 
    virtual void HidePollOnMeetingUI(bool bHide) = 0;
 
    virtual void DisableAdvanceAudioDeivceCtrl(bool bDisable) = 0;
 
    virtual void RedirectClickAudioBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectClickAudioMenuBTNEvent(bool bRedirect) = 0;
 
    virtual void RedirectClickBreakoutRoomButtonEvent(bool bRedirect) = 0;
 
    virtual void HideReactionsOnMeetingUI(bool bHide) = 0;
 
    virtual void HideMeetingInfoOnMeetingUI(bool bHide) = 0;
 
    virtual void HideShareButtonOnMeetingUI(bool bHide) = 0;
 
    virtual void DisablePanelistMenuItem(PanelistMenuItemOption menuOption) = 0;
 
    virtual void DisableAttendeeMenuItem(AttendeeMenuItemOption menuOption) = 0;
 
    virtual void EnableInviteLinkOnMeetingUI(bool bEnable) = 0;
 
    virtual void EnableCloudWhiteboard(bool bEnable) = 0;
 
    virtual void HideCloudWhiteboardFeedbackButton(bool bHide) = 0;
 
    virtual void HideCloudWhiteboardShareButton(bool bHide) = 0;
 
    virtual void HideCloudWhiteboardAboutButton(bool bHide) = 0;
 
    virtual void HideCloudWhiteboardHelperCenterButton(bool bHide) = 0;
 
    virtual void HideCloudWhiteboardOpenInBrowserButton(bool bHide) = 0;
 
    virtual void HideRequestRecordPrivilegeDialog(bool bHide) = 0;
};
#endif
class IJoinMeetingBehaviorConfiguration
{
public:
 
    virtual void EnableAutoEndOtherMeetingWhenStartMeeting(bool bEnable) = 0;
 
    virtual void RedirectWebinarNeedRegister(bool bRedirect) = 0;
 
    virtual void RedirectWebinarNameInputDialog(bool bRedirect) = 0;
 
    virtual void RedirectMeetingInputUserInfoDialog(bool bRedirect) = 0;
 
    virtual void RedirectConfirmStartArchiveDialog(bool bRedirect) = 0;
 
    virtual void RedirectConfirmRecoverMeetingDialog(bool bRedirect) = 0;
 
    virtual void RedirectEndOtherMeeting(bool bRedirect) = 0;
    
    virtual void EnableForceAutoStartMyVideoWhenJoinMeeting(bool bEnable) = 0;
 
    virtual void EnableForceAutoStopMyVideoWhenJoinMeeting(bool bEnable) = 0;
#if defined(WIN32)
    virtual void DisablePopupMeetingWrongPSWDlg(bool bDisable) = 0;
 
    virtual void DisableWaitingForHostDialog(bool bDisable) = 0;
 
    virtual void EnableInputMeetingPasswordDlg(bool bEnable) = 0;
 
    virtual void EnableInputMeetingScreenNameDlg(bool bEnable) = 0;
 
    virtual void PrePopulateWebinarRegistrationInfo(const zchar_t* email, const zchar_t* username) = 0;
 
    virtual void DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bool bDisable) = 0;
 
    virtual void DisableShowJoinMeetingWnd(bool bDisable) = 0;
#endif
};
 
class IMeetingConfiguration : 
#if defined(WIN32)
public IMeetingUIElemConfiguration, 
#endif
public IJoinMeetingBehaviorConfiguration
{
public:
    virtual void SetEvent(IMeetingConfigurationEvent* pEvent) = 0;
 
    virtual void Reset() = 0;
 
    virtual void EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bool bEnable) = 0;
 
    virtual void EnableAutoAdjustMicVolumeWhenJoinAudio(bool bEnable) = 0;
 
    virtual void SetMaxDurationForOnlyHostInMeeting(int nDuration) = 0;
#if defined(WIN32)
    virtual void SetDirectShareMonitorID(const zchar_t* monitorID) = 0;
 
    virtual void ConfigDSCP(int dscpAudio, int dscpVideo, bool bReset) = 0;
 
    virtual void EnableLengthLimitationOfMeetingNumber(bool bEnable) = 0;
 
    virtual void EnableShareIOSDevice(bool bEnable) = 0;
 
    virtual void EnableShareWhiteBoard(bool bEnable) = 0;
 
    virtual void ForceDisableMultiShare(bool bDisable) = 0;
 
    virtual SDKError EnableZoomDocs(bool bEnable) = 0;
#endif
};
 
END_ZOOM_SDK_NAMESPACE
#endif