Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_configuration_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_Configuration_INTERFACE_H_
7#define _MEETING_Configuration_INTERFACE_H_
8#include "zoom_sdk_def.h"
9#if defined(WIN32)
10#include "customized_resource_helper_interface.h"
11#endif
72
100
106{
107public:
112 virtual const zchar_t* GetWebinarRegisterUrl() = 0;
113
117 virtual void Release() = 0;
119};
120
126{
127public:
132 virtual SDKError InputWebinarRegisterEmailAndScreenName(const zchar_t* email, const zchar_t* screenName) = 0;
133
138 virtual void Cancel() = 0;
139
141};
142
148{
149public:
156 virtual SDKError InputName(const zchar_t* screenName) = 0;
157
163 virtual SDKError Cancel() = 0;
164
166};
172{
173public:
175
179 virtual const zchar_t* GetDefaultDisplayName() = 0;
180
185 virtual bool CanModifyDefaultDisplayName() = 0;
186
191 virtual bool IsValidEmail(const zchar_t* email) = 0;
192
198 virtual SDKError InputUserInfo(const zchar_t* name, const zchar_t* email) = 0;
199
204 virtual void Cancel() = 0;
205};
206
212{
213public:
215
219 virtual const zchar_t* GetArchiveConfirmContent() = 0;
220
226 virtual SDKError JoinWithArchive(bool bStartArchive) = 0;
227};
228
234{
235public:
237
241 virtual const zchar_t* GetRecoverMeetingContent() = 0;
242
248 virtual SDKError RecoverMeeting(bool bRecover) = 0;
249};
250
256{
257public:
262 virtual bool EndOtherMeeting() = 0;
263
268 virtual void Cancel() = 0;
270};
271
327
378#if defined(WIN32)
379enum SDKInviteDlgTabPage
380{
382 SDK_INVITEDLG_TAB_EMAILCONTACT = 0,
384 SDK_INVITEDLG_TAB_PHONECONTACT,
386 SDK_INVITEDLG_TAB_ROOMSYSTEM,
387};
388
389enum SDKH323TabPage
390{
392 SDK_INVITEDLG_H323_DIALIN = 0,
394 SDK_INVITEDLG_H323_CALLOUT,
395};
396
401typedef struct tagRedirectWarningMsgOption
402{
404 bool bRedirectBadNetwork;
406 bool bRedirectWarnHighCPU;
407 tagRedirectWarningMsgOption()
408 {
409 bRedirectBadNetwork = false;
410 bRedirectWarnHighCPU = false;
411 }
412
413}RedirectWarningMsgOption;
414
415
420typedef struct tagPanelistMenuItemOption
421{
423 bool bNotShowDowngradePanelist;
424 tagPanelistMenuItemOption()
425 {
426 bNotShowDowngradePanelist = false;
427 }
428
429}PanelistMenuItemOption;
430
435typedef struct tagAttendeeMenuItemOption
436{
438 bool bNotShowPromoteToPanelist;
439 tagAttendeeMenuItemOption()
440 {
441 bNotShowPromoteToPanelist = false;
442 }
443
444}AttendeeMenuItemOption;
449class IMeetingUIElemConfiguration
450{
451public:
456 virtual void SetMeetingUIPos(WndPosition pos) = 0;
457
463 virtual void SetFloatVideoPos(WndPosition pos) = 0;
464
470 virtual void SetSharingToolbarVisibility(bool bShow) = 0;
475 virtual void SetBottomFloatToolbarWndVisibility(bool bShow) = 0;
476
483 virtual void EnableApproveRemoteControlDlg(bool bEnable) = 0;
484
491 virtual void EnableDeclineRemoteControlResponseDlg(bool bEnable) = 0;
492
497 virtual void EnableLeaveMeetingOptionForHost(bool bEnable) = 0;
498
505 virtual void EnableInviteButtonOnMeetingUI(bool bEnable) = 0;
506
511 virtual void EnableVideoButtonOnMeetingUI(bool bEnable) = 0;
512
517 virtual void EnableAudioButtonOnMeetingUI(bool bEnable) = 0;
518
523 virtual void EnableEnterAndExitFullScreenButtonOnMeetingUI(bool bEnable) = 0;
524
529 virtual void EnableLButtonDBClick4SwitchFullScreenMode(bool bEnable) = 0;
530
535 virtual void SetFloatVideoWndVisibility(bool bShow) = 0;
536
543 virtual void RedirectClickShareBTNEvent(bool bRedirect) = 0;
544
551 virtual void RedirectClickEndMeetingBTNEvent(bool bRedirect) = 0;
552
558 virtual void RedirectFreeMeetingEndingReminderDlg(bool bRedirect) = 0;
559
566 virtual void RedirectClickCustomLiveStreamMenuEvent(bool bRedirect) = 0;
567
574 virtual void RedirectClickParticipantListBTNEvent(bool bRedirect) = 0;
575
581 virtual void RedirectClickCCBTNEvent(bool bRedirect) = 0;
582
588 virtual void RedirectMeetingWarningMsg(RedirectWarningMsgOption redirectOption) = 0;
589
594 virtual void EnableToolTipsShow(bool bEnable) = 0;
595
601 virtual void EnableClaimHostFeature(bool bEnable) = 0;
602
603
608 virtual void EnableAutoHideJoinAudioDialog(bool bEnable) = 0;
609
610
615 virtual void AlwaysShowIconOnTaskBar(bool bAlwaysShow) = 0;
616
617
623 virtual void DisableSplitScreenModeUIElements(bool bDisable) = 0;
624
629 virtual void SetShowAudioUseComputerSoundChkbox(bool bShow) = 0;
630
635 virtual void SetShowVideoOptimizeChkbox(bool bShow) = 0;
636
641 virtual void SetShowCallInTab(bool bShow) = 0;
642
647 virtual void SetShowCallMeTab(bool bShow) = 0;
648
654 virtual SDKError DisableTopMostAttr4SettingDialog(bool bDisable) = 0;
655
661 virtual SDKError EnableGrabShareWithoutReminder(bool bEnable) = 0;
662
668 virtual void EnableShowShareSwitchMultiToSingleConfirmDlg(bool bEnable) = 0;
669
675 virtual void DisableFreeMeetingRemainTimeNotify(bool bDisable) = 0;
676
681 virtual void HideChatItemOnMeetingUI(bool bHide) = 0;
682
687 virtual void HideRecordItemOnMeetingUI(bool bHide) = 0;
688
693 virtual void HideUpgradeFreeMeetingButton(bool bHide) = 0;
694
700 virtual void SetShowInviteDlgTabPage(SDKInviteDlgTabPage tabPage, bool bShow) = 0;
701
707 virtual void SetShowH323SubTabPage(SDKH323TabPage tabPage, bool bShow) = 0;
708
713 virtual void EnableLocalRecordingConvertProgressBarDialog(bool bShow) = 0;
714
719 virtual void HideSwitchCameraButton(bool bHide) = 0;
720
725 virtual void HideCopyUrlOnInviteWindow(bool bHide) = 0;
726
731 virtual void HideCopyInvitationOnInviteWindow(bool bHide) = 0;
732
737 virtual void HideKeypadButtonOnMeetingWindow(bool bHide) = 0;
738
744 virtual void HideRemoteControlOnMeetingUI(bool bHide) = 0;
745
750 virtual void HideQAOnMeetingUI(bool bHide) = 0;
751
756 virtual void HidePollOnMeetingUI(bool bHide) = 0;
757
763 virtual void DisableAdvanceAudioDeivceCtrl(bool bDisable) = 0;
764
770 virtual void RedirectClickAudioBTNEvent(bool bRedirect) = 0;
771
777 virtual void RedirectClickAudioMenuBTNEvent(bool bRedirect) = 0;
778
784 virtual void RedirectClickBreakoutRoomButtonEvent(bool bRedirect) = 0;
785
790 virtual void HideReactionsOnMeetingUI(bool bHide) = 0;
791
796 virtual void HideMeetingInfoOnMeetingUI(bool bHide) = 0;
797
802 virtual void HideShareButtonOnMeetingUI(bool bHide) = 0;
803
808 virtual void DisablePanelistMenuItem(PanelistMenuItemOption menuOption) = 0;
809
814 virtual void DisableAttendeeMenuItem(AttendeeMenuItemOption menuOption) = 0;
815
820 virtual void EnableInviteLinkOnMeetingUI(bool bEnable) = 0;
821
826 virtual void EnableCloudWhiteboard(bool bEnable) = 0;
827
832 virtual void HideCloudWhiteboardFeedbackButton(bool bHide) = 0;
833
838 virtual void HideCloudWhiteboardShareButton(bool bHide) = 0;
839
845 virtual void HideCloudWhiteboardAboutButton(bool bHide) = 0;
846
851 virtual void HideCloudWhiteboardHelperCenterButton(bool bHide) = 0;
852
857 virtual void HideCloudWhiteboardOpenInBrowserButton(bool bHide) = 0;
858
863 virtual void HideRequestRecordPrivilegeDialog(bool bHide) = 0;
864};
865#endif
866
872{
873public:
878 virtual void EnableAutoEndOtherMeetingWhenStartMeeting(bool bEnable) = 0;
879
886 virtual void RedirectWebinarNeedRegister(bool bRedirect) = 0;
887
893 virtual void RedirectWebinarNameInputDialog(bool bRedirect) = 0;
894
900 virtual void RedirectMeetingInputUserInfoDialog(bool bRedirect) = 0;
901
907 virtual void RedirectConfirmStartArchiveDialog(bool bRedirect) = 0;
908
914 virtual void RedirectConfirmRecoverMeetingDialog(bool bRedirect) = 0;
915
923 virtual void RedirectEndOtherMeeting(bool bRedirect) = 0;
924
930 virtual void EnableForceAutoStartMyVideoWhenJoinMeeting(bool bEnable) = 0;
931
937 virtual void EnableForceAutoStopMyVideoWhenJoinMeeting(bool bEnable) = 0;
938
939#if defined(WIN32)
945 virtual void DisablePopupMeetingWrongPSWDlg(bool bDisable) = 0;
946
951 virtual void DisableWaitingForHostDialog(bool bDisable) = 0;
952
960 virtual void EnableInputMeetingPasswordDlg(bool bEnable) = 0;
961
969 virtual void EnableInputMeetingScreenNameDlg(bool bEnable) = 0;
970
976 virtual void PrePopulateWebinarRegistrationInfo(const zchar_t* email, const zchar_t* username) = 0;
977
982 virtual void DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bool bDisable) = 0;
983
988 virtual void DisableShowJoinMeetingWnd(bool bDisable) = 0;
989#endif
990};
991
997#if defined(WIN32)
998public IMeetingUIElemConfiguration,
999#endif
1001{
1002public:
1007 virtual void SetEvent(IMeetingConfigurationEvent* pEvent) = 0;
1008
1012 virtual void Reset() = 0;
1013
1020 virtual void EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bool bEnable) = 0;
1021
1028 virtual void EnableAutoAdjustMicVolumeWhenJoinAudio(bool bEnable) = 0;
1029
1034 virtual void SetMaxDurationForOnlyHostInMeeting(int nDuration) = 0;
1035
1036#if defined(WIN32)
1041 virtual void SetDirectShareMonitorID(const zchar_t* monitorID) = 0;
1042
1050 virtual void ConfigDSCP(int dscpAudio, int dscpVideo, bool bReset) = 0;
1051
1057 virtual void EnableLengthLimitationOfMeetingNumber(bool bEnable) = 0;
1058
1063 virtual void EnableShareIOSDevice(bool bEnable) = 0;
1064
1069 virtual void EnableShareWhiteBoard(bool bEnable) = 0;
1070
1075 virtual void ForceDisableMultiShare(bool bDisable) = 0;
1076
1082 virtual SDKError EnableZoomDocs(bool bEnable) = 0;
1083#endif
1084};
1085
1087#endif
End other meeting to join the new meeting Handler.
virtual bool EndOtherMeeting()=0
Close another ongoing meeting.
virtual void Cancel()=0
Ignore the prompt of closing another ongoing meeting.
Meeting connect configuration Interface.
virtual void EnableForceAutoStopMyVideoWhenJoinMeeting(bool bEnable)=0
Set if it is able to force turn off video when joining the meeting. Default: FALSE.
virtual void RedirectConfirmStartArchiveDialog(bool bRedirect)=0
Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeti...
virtual void EnableAutoEndOtherMeetingWhenStartMeeting(bool bEnable)=0
Set if it is able to end automatically another ongoing meeting when joining a new meeting....
virtual void EnableForceAutoStartMyVideoWhenJoinMeeting(bool bEnable)=0
Set if it is able to force to turn on the video when join meeting. Default: FALSE.
virtual void RedirectEndOtherMeeting(bool bRedirect)=0
Set if it is able to redirect the process to end another meeting by user's own program....
virtual void RedirectWebinarNeedRegister(bool bRedirect)=0
Set if it is able to handle the webinar register process with user's own program in the meeting....
virtual void RedirectWebinarNameInputDialog(bool bRedirect)=0
Set if it is able to handle the webinar username input dlg with user's own program in the meeting....
virtual void RedirectMeetingInputUserInfoDialog(bool bRedirect)=0
Set if it is able to handle the display name and email input dlg with user's own program in the meeti...
virtual void RedirectConfirmRecoverMeetingDialog(bool bRedirect)=0
Set if it is able to handle the confirm recover meeting dialog dlg with user's own program in the mee...
user to handle confirm whether start archiving after joining the meeting.
virtual SDKError JoinWithArchive(bool bStartArchive)=0
Join the meeting.
virtual const zchar_t * GetArchiveConfirmContent()=0
The content that notifies the user to confirm starting to archive when joining the meeting.
Meeting configuration event callback.
virtual void onJoinMeetingNeedUserInfo(IMeetingInputUserInfoHandler *pHandler)=0
When joining the meeting, this callback is triggered if the user needs to input a username and email.
virtual void onUserConfirmRecoverMeeting(IMeetingConfirmRecoverHandler *handler)=0
Callback event when the host starts a deleted or expired meeting(not PMI meeting).
virtual void onWebinarNeedInputScreenName(IWebinarInputScreenNameHandler *pHandler)=0
When joining the webinar, this callback is triggered if the user needs to input a username.
virtual void onUserConfirmToStartArchive(IMeetingArchiveConfirmHandler *pHandler)=0
Callback event when joining a meeting if the admin allows the the user to choose to archive the meeti...
virtual void onWebinarNeedRegisterNotification(IWebinarNeedRegisterHandler *handler_)=0
During the webinar, this callback event will be triggered if the user needs to register.
virtual void onInputMeetingPasswordAndScreenNameNotification(IMeetingPasswordAndScreenNameHandler *pHandler)=0
The SDK will trigger the callback event if the password or screen name is required.
virtual void onEndOtherMeetingToJoinMeetingNotification(IEndOtherMeetingToJoinMeetingHandler *handler_)=0
The user will receive this callback event if the user wants to join the new meeting while the ongoing...
virtual void onFreeMeetingRemainTime(unsigned int leftTime)=0
The SDK will trigger this callback event during the free meeting to inform the user how much time is ...
virtual void onFreeMeetingNeedToUpgrade(FreeMeetingNeedUpgradeType type_, const zchar_t *gift_url)=0
The callback of upgrading the free meeting.
virtual void onFreeMeetingRemainTimeStopCountDown()=0
The callback of free meeting stops the countdown.
virtual void onFreeMeetingUpgradeToProMeeting()=0
Callback function of free meting upgrades successfully.
virtual void onFreeMeetingUpgradeToGiftFreeTrialStart()=0
Callback function of starting to upgrade the free meeting by the gift link.
FreeMeetingNeedUpgradeType
Upgrade types of free meeting. Here are more detailed structural descriptions.
virtual void onFreeMeetingUpgradeToGiftFreeTrialStop()=0
Callback function of ending upgrade the free meeting by the gift link.
Meeting configuration interface.
virtual void SetMaxDurationForOnlyHostInMeeting(int nDuration)=0
Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60.
virtual void EnableAutoAdjustMicVolumeWhenJoinAudio(bool bEnable)=0
Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE.
virtual void Reset()=0
Reset the meeting configuration and back to the default state.
virtual void EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bool bEnable)=0
Set if it is able to auto-adjust the volume of the speaker when joining the meeting....
virtual void SetEvent(IMeetingConfigurationEvent *pEvent)=0
Set meeting configuration controller callback event handler.
host to handle confirm whether recover meeting or not when start a deleted or expired meeting.
virtual SDKError RecoverMeeting(bool bRecover)=0
Join the meeting.
virtual const zchar_t * GetRecoverMeetingContent()=0
The content that notifies the host to recover the meeting.
virtual bool CanModifyDefaultDisplayName()=0
Check whether the user can modify default display name.
virtual const zchar_t * GetDefaultDisplayName()=0
Get default display name.
virtual bool IsValidEmail(const zchar_t *email)=0
Check whether the inputed email is a valid email format. The email must meet the email format require...
virtual SDKError InputUserInfo(const zchar_t *name, const zchar_t *email)=0
Complete the name and email information.
virtual void Cancel()=0
Ignore the prompt of completing the information.
Meeting screen name and password handler.
virtual void Cancel()=0
Ignore the prompt of completing the information.
virtual RequiredInfoType GetRequiredInfoType()=0
Get the type of required information to be completed.
virtual bool InputMeetingPasswordAndScreenName(const zchar_t *meetingPassword, const zchar_t *screenName)=0
Complete the password and screen name information.
virtual bool InputMeetingScreenName(const zchar_t *screenName)=0
Complete the screen name.
RequiredInfoType
Type of necessary information to join the meeting. Here are more detailed structural descriptions.
virtual bool InputMeetingIDAndScreenName(const zchar_t *meetingID, const zchar_t *screenName)=0
Complete the meeting id and screen name information.
Webinar input screen name handler.
virtual SDKError InputName(const zchar_t *screenName)=0
Input screen name to join webinar.
virtual SDKError Cancel()=0
Cancel to join webinar.
Webinar register with email and screen name Handler.
virtual SDKError InputWebinarRegisterEmailAndScreenName(const zchar_t *email, const zchar_t *screenName)=0
Configure the information of email and screen name.
virtual void Cancel()=0
Ignore the prompt of the register.
virtual void Release()=0
Release object.
virtual const zchar_t * GetWebinarRegisterUrl()=0
Get the URL to register webinar.
virtual WebinarNeedRegisterType GetWebinarNeedRegisterType()=0
Get the type to register. For more details, see WebinarNeedRegisterType enum.
WebinarNeedRegisterType
Register type of webinar. Here are more detailed structural descriptions.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.