Meeting user configuration interface. More...

#include <meeting_configuration_interface.h>

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

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

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

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

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. More...

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. More...

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. More...

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

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

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

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. More...

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. More...

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

virtual void	EnableAirplayInstructionWindow (bool bEnable)=0
	Set the visibility of the introduction window when sharing on the iOS device. Default value: TRUE. More...

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. More...

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

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. More...

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

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

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. More...

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. More...

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. More...

virtual SDKError	SetUICustomizedString (SDKCustomizedStringType customizedType, const wchar_t *customizedString)=0
	Use the custom string to replace the specified menu item. More...

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

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). More...

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. More...

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

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

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

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. More...

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

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. More...

virtual void	HideUpgradeWarningMsgForFreeUserWhenSchedule (bool bHide)=0
	Set the visibility of upgrade warning message for free user when the user schedules a meeting. Default: FALSE. More...

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. More...

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

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

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

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. More...

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. More...

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. More...

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

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

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

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

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

Detailed Description

Meeting user configuration interface.

Member Function Documentation

◆ AlwaysShowIconOnTaskBar()

virtual void IMeetingUIElemConfiguration::AlwaysShowIconOnTaskBar ( bool bAlwaysShow )

pure virtual

Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.

Parameters

bAlwaysShow TRUE indicates to display always the icon on the task-bar.

◆ DisableAdvanceAudioDeivceCtrl()

virtual void IMeetingUIElemConfiguration::DisableAdvanceAudioDeivceCtrl ( bool bDisable )

pure virtual

Set the ability to control the audio device in the meeting. Default is having the ability.

Parameters

[in] bDisable TRUE means having no ability, otherwise not. API is not recommended to call because once the bDsialbe is true, Zoom meeting may lose the control of the audio devices.

◆ DisableAttendeeMenuItem()

virtual void IMeetingUIElemConfiguration::DisableAttendeeMenuItem ( AttendeeMenuItemOption menuOption )

pure virtual

Custom the menu items show or hide for attendee.

Parameters

menuOption True indicates to hide the corresponding menu item for each item.

◆ DisableFreeMeetingRemainTimeNotify()

virtual void IMeetingUIElemConfiguration::DisableFreeMeetingRemainTimeNotify ( bool bDisable )

pure virtual

Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE.

Parameters

bDisable TRUE indicates to hide the button when the free meeting need be reminded. FALSE not.

Remarks: If the button is disabled to show, you will retrieve IMeetingConfigurationEvent::onFreeMeetingRemainTime callback event.

◆ DisablePanelistMenuItem()

virtual void IMeetingUIElemConfiguration::DisablePanelistMenuItem ( PanelistMenuItemOption menuOption )

pure virtual

Custom the menu items show or hide for panelist.

Parameters

menuOption True indicates to hide the corresponding menu item for each item.

◆ DisableSplitScreenModeUIElements()

virtual void IMeetingUIElemConfiguration::DisableSplitScreenModeUIElements ( bool bDisable )

pure virtual

Set if it is able to enable split screen during the meeting. Default value: FALSE.

Parameters

bDisable TRUE indicates to disable the split screen. FALSE not.

Remarks: This function is valid only on the primary screen. Set the value to FALSE does not mean to enable the split screen due to other restrictions.

◆ DisableTopMostAttr4SettingDialog()

virtual SDKError IMeetingUIElemConfiguration::DisableTopMostAttr4SettingDialog ( bool bDisable )

pure virtual

Whether to remove the topmost attribute of setting dialog. Default is not removed.

Parameters

bDisable TRUE indicates to remove. FALSE not.

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

◆ EnableAirplayInstructionWindow()

virtual void IMeetingUIElemConfiguration::EnableAirplayInstructionWindow ( bool bEnable )

pure virtual

Set the visibility of the introduction window when sharing on the iOS device. Default value: TRUE.

Deprecated:: Don't support this feature any more.

Parameters

bEnable TRUE indicates to display the introduction window when sharing on the iOS device. FALSE not.

Remarks: The SDK will trigger the IMeetingConfigurationEvent::onAirPlayInstructionWndNotification() callback event if the user calls this function to set to false, he shall deal with the subsequent logic himself.

◆ EnableApproveRemoteControlDlg()

virtual void IMeetingUIElemConfiguration::EnableApproveRemoteControlDlg ( bool bEnable )

pure virtual

Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the request of the remote control and then enters the sharing status at the end of callback event.

◆ EnableAudioButtonOnMeetingUI()

virtual void IMeetingUIElemConfiguration::EnableAudioButtonOnMeetingUI ( bool bEnable )

pure virtual

Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the button. Otherwise not.

◆ EnableAutoHideJoinAudioDialog()

virtual void IMeetingUIElemConfiguration::EnableAutoHideJoinAudioDialog ( bool bEnable )

pure virtual

Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.

Parameters

bEnable TRUE indicates to hide the dialog box of choosing audio when joining the meeting. FALSE not.

◆ EnableClaimHostFeature()

virtual void IMeetingUIElemConfiguration::EnableClaimHostFeature ( bool bEnable )

pure virtual

Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE.

Parameters

bEnable TRUE indicates that he can retrieve the permission of host. FALSE not.

Remarks: The original host can always claim host and is not affected by this API.

◆ EnableDeclineRemoteControlResponseDlg()

virtual void IMeetingUIElemConfiguration::EnableDeclineRemoteControlResponseDlg ( bool bEnable )

pure virtual

Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the decline request of the remote control and then exists the sharing status at the end of callback event.

◆ EnableEnterAndExitFullScreenButtonOnMeetingUI()

virtual void IMeetingUIElemConfiguration::EnableEnterAndExitFullScreenButtonOnMeetingUI ( bool bEnable )

pure virtual

Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the button. Otherwise not.

◆ EnableGrabShareWithoutReminder()

virtual SDKError IMeetingUIElemConfiguration::EnableGrabShareWithoutReminder ( bool bEnable )

pure virtual

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).

Parameters

bEnable TRUE indicates no prompt. FALSE not.

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

◆ EnableInviteButtonOnMeetingUI()

virtual void IMeetingUIElemConfiguration::EnableInviteButtonOnMeetingUI ( bool bEnable )

pure virtual

Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the button. Otherwise not.

Remarks: The user will receive the IMeetingUIControllerEvent::onInviteBtnClicked() callback event when he clicks the INVITE button. If the callback event is not handled, the SDK will pop up a ZOOM custom invitation dialog. The user will receive the IMeetingUIControllerEvent::onZoomInviteDialogFailed() callback event if the dialog box is failed to display.

◆ EnableLButtonDBClick4SwitchFullScreenMode()

virtual void IMeetingUIElemConfiguration::EnableLButtonDBClick4SwitchFullScreenMode ( bool bEnable )

pure virtual

Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.

Parameters

bEnable TRUE indicates to switch. FALSE not.

◆ EnableLeaveMeetingOptionForHost()

virtual void IMeetingUIElemConfiguration::EnableLeaveMeetingOptionForHost ( bool bEnable )

pure virtual

Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the button. Otherwise not.

◆ EnableLocalRecordingConvertProgressBarDialog()

virtual void IMeetingUIElemConfiguration::EnableLocalRecordingConvertProgressBarDialog ( bool bShow )

pure virtual

Parameters

bShow TRUE indicates to show the dialog box. FALSE not.

◆ EnableShowShareSwitchMultiToSingleConfirmDlg()

virtual void IMeetingUIElemConfiguration::EnableShowShareSwitchMultiToSingleConfirmDlg ( bool bEnable )

pure virtual

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.

Parameters

bEnable TRUE indicates to show dialog box if the multishare option is changed. FALSE not.

Remarks: If the dialog is disabled to show, you will retrieve IMeetingShareCtrlEvent::onMultiShareSwitchToSingleShareNeedConfirm callback event.

◆ EnableToolTipsShow()

virtual void IMeetingUIElemConfiguration::EnableToolTipsShow ( bool bEnable )

pure virtual

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.

Parameters

bEnable TRUE indicates to enable to show the tooltip in the meeting. FALSE not.

◆ EnableVideoButtonOnMeetingUI()

virtual void IMeetingUIElemConfiguration::EnableVideoButtonOnMeetingUI ( bool bEnable )

pure virtual

Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.

Parameters

bEnable TRUE indicates to display the button. Otherwise not.

◆ HideChatItemOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideChatItemOnMeetingUI ( bool bHide )

pure virtual

Set whether to display the button CHAT and menu item. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideCopyInvitationOnInviteWindow()

virtual void IMeetingUIElemConfiguration::HideCopyInvitationOnInviteWindow ( bool bHide )

pure virtual

Parameters

bHide TRUE indicates to hide, FALSE not.

◆ HideCopyUrlOnInviteWindow()

virtual void IMeetingUIElemConfiguration::HideCopyUrlOnInviteWindow ( bool bHide )

pure virtual

Parameters

bHide TRUE indicates to hide, FALSE not.

◆ HideKeypadButtonOnMeetingWindow()

virtual void IMeetingUIElemConfiguration::HideKeypadButtonOnMeetingWindow ( bool bHide )

pure virtual

Parameters

bHide TRUE indicates to hide, FALSE not.

◆ HideMeetingInfoOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideMeetingInfoOnMeetingUI ( bool bHide )

pure virtual

Set the visibility of meeting info button on meeting UI. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HidePollOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HidePollOnMeetingUI ( bool bHide )

pure virtual

Set the visibility of poll on meeting UI. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideQAOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideQAOnMeetingUI ( bool bHide )

pure virtual

Set the visibility of Q&A on meeting UI. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideReactionsOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideReactionsOnMeetingUI ( bool bHide )

pure virtual

Set the visibility of reaction on meeting UI. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideRecordItemOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideRecordItemOnMeetingUI ( bool bHide )

pure virtual

Set whether to display the button RECORD and menu item. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideRemoteControlOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideRemoteControlOnMeetingUI ( bool bHide )

pure virtual

Set whether to display the button REMOTE CONTROL and menu item. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

Remarks: If the calling of API with parameter TRUE is successful, SDK will call EnableApproveRemoteControlDlg(false) by default.

◆ HideShareButtonOnMeetingUI()

virtual void IMeetingUIElemConfiguration::HideShareButtonOnMeetingUI ( bool bHide )

pure virtual

Set the visibility of share button on meeting UI. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideSwitchCameraButton()

virtual void IMeetingUIElemConfiguration::HideSwitchCameraButton ( bool bHide )

pure virtual

Parameters

bHide TRUE indicates to hide the Switch Camera button. FALSE not.

◆ HideUpgradeFreeMeetingButton()

virtual void IMeetingUIElemConfiguration::HideUpgradeFreeMeetingButton ( bool bHide )

pure virtual

Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.

Parameters

[in] bHide TRUE means hiding, otherwise not.

◆ HideUpgradeWarningMsgForFreeUserWhenSchedule()

virtual void IMeetingUIElemConfiguration::HideUpgradeWarningMsgForFreeUserWhenSchedule ( bool bHide )

pure virtual

Set the visibility of upgrade warning message for free user when the user schedules a meeting. Default: FALSE.

Parameters

bHide TRUE indicates to hide the warning message.FALSE not.

◆ RedirectClickAudioBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickAudioBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingUIControllerEvent::onAudioBtnClicked(AudioBtnClickedCallbackInfo info), and the user shall deal with the subsequent logic himself.

◆ RedirectClickAudioMenuBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickAudioMenuBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingUIControllerEvent::onAudioMenuBtnClicked(), and the user shall deal with the subsequent logic himself.

◆ RedirectClickBreakoutRoomButtonEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickBreakoutRoomButtonEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingUIControllerEvent::onBreakoutRoomBtnClicked(), and the user shall deal with the subsequent logic himself.

◆ RedirectClickCCBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickCCBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingUIControllerEvent::onCCBTNClicked(), and the user shall deal with the subsequent logic himself.

◆ RedirectClickCustomLiveStreamMenuEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickCustomLiveStreamMenuEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingUIControllerEvent::onCustomLiveStreamMenuClicked() instead of jumping to the live video page when clicking on the custom live stream, then deal with the subsequent logic.

◆ RedirectClickEndMeetingBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickEndMeetingBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: The SDK won't end the meeting if the user calls this function and set to convert. The user will deal with the subsequent logic after receiving the IMeetingUIControllerEvent::onEndMeetingBtnClicked() callback event.

◆ RedirectClickParticipantListBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickParticipantListBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle with user's own program. FALSE not.

Remarks: The list won't unfold by clicking participant list button if the user calls this function to set to convert. The SDK will trigger the IMeetingUIControllerEvent::onParticipantListBtnClicked(), and the user shall deal with the subsequent logic himself.

◆ RedirectClickShareBTNEvent()

virtual void IMeetingUIElemConfiguration::RedirectClickShareBTNEvent ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to deal with the event with user's own program. FALSE not.

Remarks: The SDK won't enable the share if the user calls this function and sets to convert. The user will deal with the subsequent logic after receiving the IMeetingUIControllerEvent::onStartShareBtnClicked() callback event.

◆ RedirectFreeMeetingEndingReminderDlg()

virtual void IMeetingUIElemConfiguration::RedirectFreeMeetingEndingReminderDlg ( bool bRedirect )

pure virtual

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.

Parameters

bRedirect TRUE indicates to handle the reminder message with user's own program. FALSE not.

Remarks: The SDK will trigger the IMeetingConfigurationEvent::onFreeMeetingEndingReminderNotification() callback event when the meeting is over if the user calls this function to set the conversion.

◆ RedirectMeetingWarningMsg()

virtual void IMeetingUIElemConfiguration::RedirectMeetingWarningMsg ( RedirectWarningMsgOption redirectOption )

pure virtual

Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.

Parameters

redirectOption The parameter indicates the warning messages to be handled with user's own program.

Remarks: If the user calls this function to convert, the SDK will trigger the IMeetingServiceEvent::onMeetingStatisticsWarningNotification(), and the user shall deal with the subsequent logic himself.

◆ SetBottomFloatToolbarWndVisibility()

virtual void IMeetingUIElemConfiguration::SetBottomFloatToolbarWndVisibility ( bool bShow )

pure virtual

Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.

Parameters

bShow TRUE means to enable the feature to display always the toolbar at the bottom. Otherwise not.

◆ SetFloatVideoPos()

virtual void IMeetingUIElemConfiguration::SetFloatVideoPos ( WndPosition pos )

pure virtual

Set the position of the floating video window when sharing.

Parameters

pos	Specify the position of the floating video window when sharing.

Remarks: The value shall be set before the sharing begins. If you set the value during the process of share, the function will not be valid until the next share.

◆ SetFloatVideoWndVisibility()

virtual void IMeetingUIElemConfiguration::SetFloatVideoWndVisibility ( bool bShow )

pure virtual

Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.

Parameters

bShow TRUE indicates to display the floating video window. FALSE not.

◆ SetMeetingUIPos()

virtual void IMeetingUIElemConfiguration::SetMeetingUIPos ( WndPosition pos )

pure virtual

Set the position of the primary view meeting window.

Parameters

pos	Specify the position of the primary view meeting window. The coordinates of the window are those of the screen.

◆ SetSharingToolbarVisibility()

virtual void IMeetingUIElemConfiguration::SetSharingToolbarVisibility ( bool bShow )

pure virtual

Set the visibility of the sharing toolbar. Default value: TRUE.

Parameters

bShow TRUE means to enable the display sharing toolbar. Otherwise not.

Remarks: This function works only before the meeting or the sharing starts.

◆ SetShowAudioUseComputerSoundChkbox()

virtual void IMeetingUIElemConfiguration::SetShowAudioUseComputerSoundChkbox ( bool bShow )

pure virtual

Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.

Parameters

bShow TRUE indicates to display. FALSE not.

◆ SetShowCallInTab()

virtual void IMeetingUIElemConfiguration::SetShowCallInTab ( bool bShow )

pure virtual

Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.

Parameters

bShow TRUE indicates to display the tab. FALSE not.

◆ SetShowCallMeTab()

virtual void IMeetingUIElemConfiguration::SetShowCallMeTab ( bool bShow )

pure virtual

Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.

Parameters

bShow TRUE indicates to display the tab. FALSE not.

◆ SetShowH323SubTabPage()

virtual void IMeetingUIElemConfiguration::SetShowH323SubTabPage	(	SDKH323TabPage	tabPage,
		bool	bShow
	)

pure virtual

Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.

Parameters

tabPage	Specify a tab, see SDKH323TabPage enum.
bShow	TRUE indicates to display the tab. FALSE not.

◆ SetShowInviteDlgTabPage()

virtual void IMeetingUIElemConfiguration::SetShowInviteDlgTabPage	(	SDKInviteDlgTabPage	tabPage,
		bool	bShow
	)

pure virtual

Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.

Parameters

tabPage	Specify a tab page, see SDKInviteDlgTabPage enum.
bShow	TRUE indicates to display the tab. FALSE not.

◆ SetShowVideoOptimizeChkbox()

virtual void IMeetingUIElemConfiguration::SetShowVideoOptimizeChkbox ( bool bShow )

pure virtual

Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.

Parameters

bShow TRUE indicates to display. FALSE not.

◆ SetUICustomizedString()

virtual SDKError IMeetingUIElemConfiguration::SetUICustomizedString	(	SDKCustomizedStringType	customizedType,
		const wchar_t *	customizedString
	)

pure virtual

Use the custom string to replace the specified menu item.

Deprecated:: This function will be deprecated, please use ICustomizedResourceHelper.AddCustomizedStringResouce() instead.

Parameters

customizedType	Specify the menu item type. For more information, see SDKCustomizedStringType enum.
customizedString	Specify the custom string. You can set it to NULL to remove the custom string for the specified item.

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

Remarks: If customizedString is not NULL with length zero(0), the return value is SDKERR_INVALID_PARAMETER.

The documentation for this class was generated from the following file:

h/meeting_service_components/meeting_configuration_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AlwaysShowIconOnTaskBar()

◆ DisableAdvanceAudioDeivceCtrl()

◆ DisableAttendeeMenuItem()

◆ DisableFreeMeetingRemainTimeNotify()

◆ DisablePanelistMenuItem()

◆ DisableSplitScreenModeUIElements()

◆ DisableTopMostAttr4SettingDialog()

◆ EnableAirplayInstructionWindow()

◆ EnableApproveRemoteControlDlg()

◆ EnableAudioButtonOnMeetingUI()

◆ EnableAutoHideJoinAudioDialog()

◆ EnableClaimHostFeature()

◆ EnableDeclineRemoteControlResponseDlg()

◆ EnableEnterAndExitFullScreenButtonOnMeetingUI()

◆ EnableGrabShareWithoutReminder()

◆ EnableInviteButtonOnMeetingUI()

◆ EnableLButtonDBClick4SwitchFullScreenMode()

◆ EnableLeaveMeetingOptionForHost()

◆ EnableLocalRecordingConvertProgressBarDialog()

◆ EnableShowShareSwitchMultiToSingleConfirmDlg()

◆ EnableToolTipsShow()

◆ EnableVideoButtonOnMeetingUI()

◆ HideChatItemOnMeetingUI()

◆ HideCopyInvitationOnInviteWindow()

◆ HideCopyUrlOnInviteWindow()

◆ HideKeypadButtonOnMeetingWindow()

◆ HideMeetingInfoOnMeetingUI()

◆ HidePollOnMeetingUI()

◆ HideQAOnMeetingUI()

◆ HideReactionsOnMeetingUI()

◆ HideRecordItemOnMeetingUI()

◆ HideRemoteControlOnMeetingUI()

◆ HideShareButtonOnMeetingUI()

◆ HideSwitchCameraButton()

◆ HideUpgradeFreeMeetingButton()

◆ HideUpgradeWarningMsgForFreeUserWhenSchedule()

◆ RedirectClickAudioBTNEvent()

◆ RedirectClickAudioMenuBTNEvent()

◆ RedirectClickBreakoutRoomButtonEvent()

◆ RedirectClickCCBTNEvent()

◆ RedirectClickCustomLiveStreamMenuEvent()

◆ RedirectClickEndMeetingBTNEvent()

◆ RedirectClickParticipantListBTNEvent()

◆ RedirectClickShareBTNEvent()

◆ RedirectFreeMeetingEndingReminderDlg()

◆ RedirectMeetingWarningMsg()

◆ SetBottomFloatToolbarWndVisibility()

◆ SetFloatVideoPos()

◆ SetFloatVideoWndVisibility()

◆ SetMeetingUIPos()

◆ SetSharingToolbarVisibility()

◆ SetShowAudioUseComputerSoundChkbox()

◆ SetShowCallInTab()

◆ SetShowCallMeTab()

◆ SetShowH323SubTabPage()

◆ SetShowInviteDlgTabPage()

◆ SetShowVideoOptimizeChkbox()

◆ SetUICustomizedString()