Meeting configuration interface. More...

#include <meeting_configuration_interface.h>

Inherits IMeetingUIElemConfiguration, and IJoinMeetingBehaviorConfiguration.

Public Member Functions
virtual void	SetEvent (IMeetingConfigurationEvent *pEvent)=0
	Set meeting configuration controller callback event handler.

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. Default: TRUE.

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	SetMaxDurationForOnlyHostInMeeting (int nDuration)=0
	Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60.

virtual void	SetDirectShareMonitorID (const zchar_t *monitorID)=0
	Set the shared device ID when sharing directly.

virtual void	ConfigDSCP (int dscpAudio, int dscpVideo, bool bReset)=0
	Configure DSCP(Differential services code point) values.

virtual void	EnableLengthLimitationOfMeetingNumber (bool bEnable)=0
	Set if it is able to limit the length of meeting ID. Default: FALSE.

virtual void	EnableShareIOSDevice (bool bEnable)=0
	Set if it is able to share IOS device. Default: FALSE.

virtual void	EnableShareWhiteBoard (bool bEnable)=0
	Set if it is able to share white board. Default: TRUE.

virtual void	ForceDisableMultiShare (bool bDisable)=0
	Set whether to forbid multi-share. Default: FALSE.

virtual SDKError	EnableZoomDocs (bool bEnable)=0
	Enable or disable zoom docs features in custom UI. This is disabled by default.

Public Member Functions inherited from IMeetingUIElemConfiguration
virtual void	SetMeetingUIPos (WndPosition pos)=0
	Set the position of the primary view meeting window.

virtual void	SetFloatVideoPos (WndPosition pos)=0
	Set the position of the floating video window when sharing.

virtual void	SetSharingToolbarVisibility (bool bShow)=0
	Set the visibility of the sharing toolbar. Default value: TRUE.

virtual void	SetBottomFloatToolbarWndVisibility (bool bShow)=0
	Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.

virtual void	EnableApproveRemoteControlDlg (bool bEnable)=0
	Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.

virtual void	EnableDeclineRemoteControlResponseDlg (bool bEnable)=0
	Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.

virtual void	EnableLeaveMeetingOptionForHost (bool bEnable)=0
	Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.

virtual void	EnableInviteButtonOnMeetingUI (bool bEnable)=0
	Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE.

virtual void	EnableVideoButtonOnMeetingUI (bool bEnable)=0
	Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.

virtual void	EnableAudioButtonOnMeetingUI (bool bEnable)=0
	Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.

virtual void	EnableEnterAndExitFullScreenButtonOnMeetingUI (bool bEnable)=0
	Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.

virtual void	EnableLButtonDBClick4SwitchFullScreenMode (bool bEnable)=0
	Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.

virtual void	SetFloatVideoWndVisibility (bool bShow)=0
	Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.

virtual void	RedirectClickShareBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with user's own program by clicking START SHARE button in the meeting. Default value: FALSE.

virtual void	RedirectClickEndMeetingBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with user's own program by clicking END MEETING button in the meeting. Default value: FALSE.

virtual void	RedirectFreeMeetingEndingReminderDlg (bool bRedirect)=0
	An upgrade dialog box will pop up when the free meeting is over. Use this function to set if it is able to handle the reminder message with user's own program. Default value: FALSE.

virtual void	RedirectClickCustomLiveStreamMenuEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking CUSTOM LIVE STREAM button in the meeting. Default value: FALSE.

virtual void	RedirectClickParticipantListBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking PARTICIPANT LIST button in the meeting. Default value: FALSE.

virtual void	RedirectClickCCBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking Closed Caption button in the meeting. Default value: FALSE.

virtual void	RedirectMeetingWarningMsg (RedirectWarningMsgOption redirectOption)=0
	Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.

virtual void	EnableToolTipsShow (bool bEnable)=0
	Set if it is able to temporarily show tooltip of the button in the toolbar of the meeting and user can close it by click the "x". Default value: TRUE.

virtual void	EnableClaimHostFeature (bool bEnable)=0
	Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE.

virtual void	EnableAutoHideJoinAudioDialog (bool bEnable)=0
	Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.

virtual void	AlwaysShowIconOnTaskBar (bool bAlwaysShow)=0
	Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.

virtual void	DisableSplitScreenModeUIElements (bool bDisable)=0
	Set if it is able to enable split screen during the meeting. Default value: FALSE.

virtual void	SetShowAudioUseComputerSoundChkbox (bool bShow)=0
	Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.

virtual void	SetShowVideoOptimizeChkbox (bool bShow)=0
	Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.

virtual void	SetShowCallInTab (bool bShow)=0
	Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.

virtual void	SetShowCallMeTab (bool bShow)=0
	Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.

virtual SDKError	DisableTopMostAttr4SettingDialog (bool bDisable)=0
	Whether to remove the topmost attribute of setting dialog. Default is not removed.

virtual SDKError	EnableGrabShareWithoutReminder (bool bEnable)=0
	Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).

virtual void	EnableShowShareSwitchMultiToSingleConfirmDlg (bool bEnable)=0
	Set the visibility of the SWITCH TO SINGLE PARTICIPANT SHARE dialog box when multiple participants are sharing and the user try to change the setting to single share. Default: TURE.

virtual void	DisableFreeMeetingRemainTimeNotify (bool bDisable)=0
	Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE.

virtual void	HideChatItemOnMeetingUI (bool bHide)=0
	Set whether to display the button CHAT and menu item. Default is displaying.

virtual void	HideRecordItemOnMeetingUI (bool bHide)=0
	Set whether to display the button RECORD and menu item. Default is displaying.

virtual void	HideUpgradeFreeMeetingButton (bool bHide)=0
	Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.

virtual void	SetShowInviteDlgTabPage (SDKInviteDlgTabPage tabPage, bool bShow)=0
	Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.

virtual void	SetShowH323SubTabPage (SDKH323TabPage tabPage, bool bShow)=0
	Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.

virtual void	EnableLocalRecordingConvertProgressBarDialog (bool bShow)=0

virtual void	HideSwitchCameraButton (bool bHide)=0

virtual void	HideCopyUrlOnInviteWindow (bool bHide)=0

virtual void	HideCopyInvitationOnInviteWindow (bool bHide)=0

virtual void	HideKeypadButtonOnMeetingWindow (bool bHide)=0

virtual void	HideRemoteControlOnMeetingUI (bool bHide)=0
	Set whether to display the button REMOTE CONTROL and menu item. Default is displaying.

virtual void	HideQAOnMeetingUI (bool bHide)=0
	Set the visibility of Q&A on meeting UI. Default is displaying.

virtual void	HidePollOnMeetingUI (bool bHide)=0
	Set the visibility of poll on meeting UI. Default is displaying.

virtual void	DisableAdvanceAudioDeivceCtrl (bool bDisable)=0
	Set the ability to control the audio device in the meeting. Default is having the ability.

virtual void	RedirectClickAudioBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking Audio button in the meeting. Default value: FALSE.

virtual void	RedirectClickAudioMenuBTNEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking Audio Menu button in the meeting. Default value: FALSE.

virtual void	RedirectClickBreakoutRoomButtonEvent (bool bRedirect)=0
	Set if it is able to handle the event with SDK user's own program by clicking Breakout Room button in the meeting. Default value: FALSE.

virtual void	HideReactionsOnMeetingUI (bool bHide)=0
	Set the visibility of reaction on meeting UI. Default is displaying.

virtual void	HideMeetingInfoOnMeetingUI (bool bHide)=0
	Set the visibility of meeting info button on meeting UI. Default is displaying.

virtual void	HideShareButtonOnMeetingUI (bool bHide)=0
	Set the visibility of share button on meeting UI. Default is displaying.

virtual void	DisablePanelistMenuItem (PanelistMenuItemOption menuOption)=0
	Custom the menu items show or hide for panelist.

virtual void	DisableAttendeeMenuItem (AttendeeMenuItemOption menuOption)=0
	Custom the menu items show or hide for attendee.

virtual void	EnableInviteLinkOnMeetingUI (bool bEnable)=0
	Set the visibility of the INVITE link during the meeting. Default value: TRUE.

virtual void	EnableCloudWhiteboard (bool bEnable)=0
	Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This is enabled by default.

virtual void	HideCloudWhiteboardFeedbackButton (bool bHide)=0
	Set Leave Feedback button's visibility on cloud whiteboard. Default is displaying.

virtual void	HideCloudWhiteboardShareButton (bool bHide)=0
	Set Share button's visibility on cloud whiteboard. Default is displaying.

virtual void	HideCloudWhiteboardAboutButton (bool bHide)=0
	Set the About button's visibility on cloud whiteboard. Default is displaying.

virtual void	HideCloudWhiteboardHelperCenterButton (bool bHide)=0
	Set the Helper center button's visibility on cloud whiteboard. Default is displaying.

virtual void	HideCloudWhiteboardOpenInBrowserButton (bool bHide)=0
	Set the Open in browser button's visibility on cloud whiteboard. Default is displaying.

virtual void	HideRequestRecordPrivilegeDialog (bool bHide)=0
	Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.

Public Member Functions inherited from IJoinMeetingBehaviorConfiguration
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 configuration interface.

Definition at line 711 of file meeting_configuration_interface.h.

Member Function Documentation

◆ ConfigDSCP()

virtual void IMeetingConfiguration::ConfigDSCP	(	int	dscpAudio,
		int	dscpVideo,
		bool	bReset )

pure virtual

Configure DSCP(Differential services code point) values.

Parameters

dscpAudio	Configure DSCP value for audio.
dscpVideo	Configure DSCP value for video.
bReset	Reset DSCP values.

Remarks: This interface satisfies some users who have other requirements. It is not recommended to configure it. Contact the support engineer for more details.

◆ EnableAutoAdjustMicVolumeWhenJoinAudio()

virtual void IMeetingConfiguration::EnableAutoAdjustMicVolumeWhenJoinAudio ( bool bEnable )

pure virtual

Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE.

Parameters

bEnable TRUE indicates to auto-adjust the volume of the mic. FALSE not.

Remarks: If it is TRUE, the SDK will adjust the mic volume automatically. It will unmute if the mic was muted.

Deprecated: This interface is marked as deprecated.

◆ EnableAutoAdjustSpeakerVolumeWhenJoinAudio()

virtual void IMeetingConfiguration::EnableAutoAdjustSpeakerVolumeWhenJoinAudio ( bool bEnable )

pure virtual

Set if it is able to auto-adjust the volume of the speaker when joining the meeting. Default: TRUE.

Parameters

bEnable TRUE indicates to auto-adjust the volume of the speaker. FALSE not.

Remarks: If it is TRUE, the SDK will adjust the speaker volume automatically. It will unmute if the speaker was muted.

Deprecated: This interface is marked as deprecated.

◆ EnableLengthLimitationOfMeetingNumber()

virtual void IMeetingConfiguration::EnableLengthLimitationOfMeetingNumber ( bool bEnable )

pure virtual

Set if it is able to limit the length of meeting ID. Default: FALSE.

Parameters

bEnable TRUE indicates to limit the length of meeting ID. FALSE not.

Remarks: If it is enabled, the length of the meeting ID depends on the ID type. The ID shall be more than nine(9) figures or five(5) letters. Also, The meeting ID will be displayed as it is (not formatted).

◆ EnableShareIOSDevice()

virtual void IMeetingConfiguration::EnableShareIOSDevice ( bool bEnable )

pure virtual

Set if it is able to share IOS device. Default: FALSE.

Parameters

bEnable TRUE indicates to enable to share. FALSE not.

◆ EnableShareWhiteBoard()

virtual void IMeetingConfiguration::EnableShareWhiteBoard ( bool bEnable )

pure virtual

Set if it is able to share white board. Default: TRUE.

Parameters

bEnable TRUE indicates to enable to share on the white board. FALSE not.

◆ EnableZoomDocs()

virtual SDKError IMeetingConfiguration::EnableZoomDocs ( bool bEnable )

pure virtual

Enable or disable zoom docs features in custom UI. This is disabled by default.

Parameters

bEnable TRUE indicates to enable the zoom docs feature, otherwise not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ ForceDisableMultiShare()

virtual void IMeetingConfiguration::ForceDisableMultiShare ( bool bDisable )

pure virtual

Set whether to forbid multi-share. Default: FALSE.

Parameters

bDisable TRUE indicates to forbid multi-share. FALSE not.

◆ Reset()

virtual void IMeetingConfiguration::Reset ( )

pure virtual

Reset the meeting configuration and back to the default state.

◆ SetDirectShareMonitorID()

virtual void IMeetingConfiguration::SetDirectShareMonitorID ( const zchar_t * monitorID )

pure virtual

Set the shared device ID when sharing directly.

Parameters

monitorID Specify the device ID to be shared. You may get the device ID by the system API EnumDisplayMonitors().

◆ SetEvent()

virtual void IMeetingConfiguration::SetEvent ( IMeetingConfigurationEvent * pEvent )

pure virtual

Set meeting configuration controller callback event handler.

Parameters

pEvent A pointer to the IMeetingConfigurationEvent that receives the configuration controller event. For more details, see IMeetingConfigurationEvent.

◆ SetMaxDurationForOnlyHostInMeeting()

virtual void IMeetingConfiguration::SetMaxDurationForOnlyHostInMeeting ( int nDuration )

pure virtual

Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60.

Parameters

nDuration Specify the maximum duration in minutes.

Public Member Functions

Detailed Description

Member Function Documentation

◆ ConfigDSCP()

◆ EnableAutoAdjustMicVolumeWhenJoinAudio()

◆ EnableAutoAdjustSpeakerVolumeWhenJoinAudio()

◆ EnableLengthLimitationOfMeetingNumber()

◆ EnableShareIOSDevice()

◆ EnableShareWhiteBoard()

◆ EnableZoomDocs()

◆ ForceDisableMultiShare()

◆ Reset()

◆ SetDirectShareMonitorID()

◆ SetEvent()

◆ SetMaxDurationForOnlyHostInMeeting()