Meeting SDK for Windows API Reference
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions
IJoinMeetingBehaviorConfiguration Class Referenceabstract

Meeting connect configuration Interface. More...

#include <meeting_configuration_interface.h>

Inherited by IMeetingConfiguration.

Public Member Functions

virtual void EnableAutoEndOtherMeetingWhenStartMeeting (bool bEnable)=0
 Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.
 
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. Default: FALSE.
 
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. Default: FALSE.
 
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 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 meeting. Default: FALSE.
 
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 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. Default: FALSE.
 
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 EnableForceAutoStopMyVideoWhenJoinMeeting (bool bEnable)=0
 Set if it is able to force turn off video when joining the meeting. Default: FALSE.
 
virtual void DisablePopupMeetingWrongPSWDlg (bool bDisable)=0
 Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE.
 
virtual void DisableWaitingForHostDialog (bool bDisable)=0
 Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.
 
virtual void EnableInputMeetingPasswordDlg (bool bEnable)=0
 Set the visibility of the dialog box to input the password. Default: TRUE.
 
virtual void EnableInputMeetingScreenNameDlg (bool bEnable)=0
 Set the visibility of the dialog box to input the screen name. Default: TRUE.
 
virtual void PrePopulateWebinarRegistrationInfo (const zchar_t *email, const zchar_t *username)=0
 Pre-set email and username information before joining the webinar.
 
virtual void DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting (bool bDisable)=0
 Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.
 
virtual void DisableShowJoinMeetingWnd (bool bDisable)=0
 Set the visibility of the dialog box of joining a meeting. Default: FALSE.
 

Detailed Description

Meeting connect configuration Interface.

Definition at line 627 of file meeting_configuration_interface.h.

Member Function Documentation

◆ DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting()

virtual void IJoinMeetingBehaviorConfiguration::DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting ( bool bDisable)
pure virtual

Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.

Parameters
bDisableTRUE indicates to hide the dialog box.

◆ DisablePopupMeetingWrongPSWDlg()

virtual void IJoinMeetingBehaviorConfiguration::DisablePopupMeetingWrongPSWDlg ( bool bDisable)
pure virtual

Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE.

Parameters
bDisableTRUE indicates to hide the dialog box of wrong password.
Remarks
If it is disabled to display the dialog box of wrong password, the system will directly exit the state of trying to join the meeting.

◆ DisableShowJoinMeetingWnd()

virtual void IJoinMeetingBehaviorConfiguration::DisableShowJoinMeetingWnd ( bool bDisable)
pure virtual

Set the visibility of the dialog box of joining a meeting. Default: FALSE.

Parameters
bDisableTRUE indicates to hide the dialog box. FALSE not.

◆ DisableWaitingForHostDialog()

virtual void IJoinMeetingBehaviorConfiguration::DisableWaitingForHostDialog ( bool bDisable)
pure virtual

Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.

Parameters
bDisableTRUE indicates to hide the dialog box. FALSE not.

◆ EnableAutoEndOtherMeetingWhenStartMeeting()

virtual void IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting ( bool bEnable)
pure virtual

Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.

Parameters
bEnableTRUE indicates to end the other ongoing meetings. FALSE not.

◆ EnableForceAutoStartMyVideoWhenJoinMeeting()

virtual void IJoinMeetingBehaviorConfiguration::EnableForceAutoStartMyVideoWhenJoinMeeting ( bool bEnable)
pure virtual

Set if it is able to force to turn on the video when join meeting. Default: FALSE.

Parameters
bEnableTRUE indicates to force to start video.
Remarks
The default behavior depends on the configuration of the meeting.

◆ EnableForceAutoStopMyVideoWhenJoinMeeting()

virtual void IJoinMeetingBehaviorConfiguration::EnableForceAutoStopMyVideoWhenJoinMeeting ( bool bEnable)
pure virtual

Set if it is able to force turn off video when joining the meeting. Default: FALSE.

Parameters
bEnableTRUE indicates to force to turn off the video.
Remarks
The default behavior depends on the configuration of the meeting.

◆ EnableInputMeetingPasswordDlg()

virtual void IJoinMeetingBehaviorConfiguration::EnableInputMeetingPasswordDlg ( bool bEnable)
pure virtual

Set the visibility of the dialog box to input the password. Default: TRUE.

Parameters
bEnableTRUE indicates to display the dialog box to input password. FALSE not.
Remarks
If it is disabled, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the password, then the user shall deal with the subsequent logic. For more details, see IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification().

◆ EnableInputMeetingScreenNameDlg()

virtual void IJoinMeetingBehaviorConfiguration::EnableInputMeetingScreenNameDlg ( bool bEnable)
pure virtual

Set the visibility of the dialog box to input the screen name. Default: TRUE.

Parameters
bEnableTRUE indicates to display the dialog box to input the screen name which is to be displayed in the meeting. FALSE not.
Remarks
If it is false, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the screen name, then the user shall deal with the subsequent logic. For more details, see IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification().

◆ PrePopulateWebinarRegistrationInfo()

virtual void IJoinMeetingBehaviorConfiguration::PrePopulateWebinarRegistrationInfo ( const zchar_t * email,
const zchar_t * username )
pure virtual

Pre-set email and username information before joining the webinar.

Parameters
emailConfigure the default email.
usernameConfigure default username.

◆ RedirectConfirmRecoverMeetingDialog()

virtual void IJoinMeetingBehaviorConfiguration::RedirectConfirmRecoverMeetingDialog ( bool bRedirect)
pure virtual

Set if it is able to handle the confirm recover meeting dialog dlg with user's own program in the meeting. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not.
Remarks
If it is true, the SDK will trigger the IMeetingConfigurationEvent::onUserConfirmRecoverMeeting()callback event. For more details, see IMeetingConfigurationEvent::onUserConfirmRecoverMeeting().

◆ RedirectConfirmStartArchiveDialog()

virtual void IJoinMeetingBehaviorConfiguration::RedirectConfirmStartArchiveDialog ( bool bRedirect)
pure virtual

Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeting. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not.
Remarks
If it is true, the SDK will trigger the IMeetingConfigurationEvent::onUserConfirmToStartArchive()callback event. For more details, see IMeetingConfigurationEvent::onUserConfirmToStartArchive().

◆ RedirectEndOtherMeeting()

virtual void IJoinMeetingBehaviorConfiguration::RedirectEndOtherMeeting ( bool bRedirect)
pure virtual

Set if it is able to redirect the process to end another meeting by user's own program. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not. If it is TRUE, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification().
Remarks
This function doesn't work if the IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting(true) is also called. If redirect successfully, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification() callback event. For more details, see IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification().

◆ RedirectMeetingInputUserInfoDialog()

virtual void IJoinMeetingBehaviorConfiguration::RedirectMeetingInputUserInfoDialog ( bool bRedirect)
pure virtual

Set if it is able to handle the display name and email input dlg with user's own program in the meeting. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not.
Remarks
If it is true, the SDK will trigger the IMeetingConfigurationEvent::onJoinMeetingNeedUserInfo()callback event. For more details, see IMeetingConfigurationEvent::onJoinMeetingNeedUserInfo().

◆ RedirectWebinarNameInputDialog()

virtual void IJoinMeetingBehaviorConfiguration::RedirectWebinarNameInputDialog ( bool bRedirect)
pure virtual

Set if it is able to handle the webinar username input dlg with user's own program in the meeting. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not.
Remarks
If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedInputScreenName()callback event. For more details, see IMeetingConfigurationEvent::onWebinarNeedInputScreenName().

◆ RedirectWebinarNeedRegister()

virtual void IJoinMeetingBehaviorConfiguration::RedirectWebinarNeedRegister ( bool bRedirect)
pure virtual

Set if it is able to handle the webinar register process with user's own program in the meeting. Default: FALSE.

Parameters
bRedirectTRUE indicates to redirect. FALSE not.
Remarks
If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedRegisterNotification()callback event. For more details, see IMeetingConfigurationEvent::onWebinarNeedRegisterNotification().