Meeting UI Controller Interface. More...

#include <meeting_ui_ctrl_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingUIControllerEvent *pEvent)=0
	Set meeting UI controller callback event handler.

virtual SDKError	ShowChatDlg (ShowChatDlgParam &param)=0
	Show the chat dialog during the meeting.

virtual SDKError	HideChatDlg ()=0
	Hide the chat dialog during the meeting.

virtual SDKError	EnterFullScreen (bool firstView, bool secondView)=0
	Enter full screen display mode.

virtual SDKError	ExitFullScreen (bool firstView, bool secondView)=0
	Exit the full screen display mode.

virtual SDKError	BackToMeeting ()=0
	Active the principal window of meeting and place it on top.

virtual SDKError	SwitchToVideoWall ()=0
	Switch to video wall mode.

virtual SDKError	SwitchToActiveSpeaker ()=0
	Switch to the mode of showing the current speaker.

virtual SDKError	MoveFloatVideoWnd (int left, int top)=0
	Move the floating video window.

virtual SDKError	ShowSharingToolbar (bool bShow)=0
	Enable or disable to display the floating sharing toolbar.

virtual SDKError	SwitchFloatVideoToActiveSpkMod ()=0
	Switch to current speaker mode on the floating window.

virtual SDKError	ChangeFloatToActiveSpkVideoSize (SDKFloatVideoType type)=0
	Adjust the display mode of floating window.

virtual SDKError	SwitchFloatVideoToGalleryMod ()=0
	Switch to gallery view mode on the floating window.

virtual SDKError	ShowParticipantsListWnd (bool bShow, HWND &hParticipantsListWnd)=0
	Display/hide the window which is used to display the list of the participants.

virtual SDKError	ShowBottomFloatToolbarWnd (bool bShow)=0
	Display/hide the toolbar at the bottom of the meeting window.

virtual SDKError	GetMeetingUIWnd (HWND &hFirstView, HWND &hSecondView)=0
	Get the window handle of the meeting user interface.

virtual SDKError	ShowJoinAudioDlg ()=0
	Display the dialog to choose the audio to join the meeting.

virtual SDKError	HideJoinAudioDlg ()=0
	Hide the dialog to choose the audio to join the meeting.

virtual SDKError	GetWallViewPageInfo (VideoWallPageInfoParam &videoWallPageInfoParam)=0
	Get the information in video wall mode.

virtual SDKError	ShowPreOrNextPageVideo (bool bPageUp)=0
	Show the video users on previous page or next page in video wall mode.

virtual SDKError	ShowSharingFrameWindows (bool bShow)=0
	Set the visibility of the green frame when sharing the desktop.

virtual bool	IsMinimizeModeOfFirstScreenMeetingUIWnd (SDKMinimizeUIMode &mode)=0
	Determines the minimize state of the first view.

virtual SDKError	SwitchMinimizeUIMode4FirstScreenMeetingUIWnd (SDKMinimizeUIMode mode)=0
	Change the display mode of the minimized meeting window for the first view.

virtual SDKError	GetCurrentSplitScreenModeInfo (SplitScreenInfo &info)=0
	Get the information whether the current view supports split screen mode or not. If supports, check it if it is already in the split screen mode.

virtual SDKError	SwitchSplitScreenMode (bool bSplit)=0
	Switch to the split screen mode or cancel.

virtual SDKError	SwapToShowShareViewOrVideo (bool bToDisplayShare)=0
	when someone else shares, and meeting window is not full screen. you can call the api to switch video & share display postion.

virtual SDKError	IsDisplayingShareViewOrVideo (bool &bIsShare)=0
	Determine if the meeting is displaying the sharing screen now.

virtual SDKError	CanSwapToShowShareViewOrVideo (bool &bCan)=0
	Determine if the user can swap to show sharing screen or video now.

virtual SDKError	SetMeetingTopic (const zchar_t *meetingtopic)=0
	Set the meeting topic in the meeting information page.

virtual SDKError	SetCustomizedCloudRecordingMgrUrl (const zchar_t *crmURL)=0
	Set the cloud recording manage url in the recording setting page.

virtual SDKError	SetCustomizedInvitationDomain (const zchar_t *invitation_domain)=0
	Set the invitation domain.

virtual SDKError	SetCustomizedPollingUrl (const zchar_t *URL, bool bCreate)=0
	Allowing the developer to customize the URL of create/edit the polling.

virtual SDKError	SetCloudWhiteboardFeedbackUrl (const zchar_t *feedbackURL)=0
	Set the feedback url in the whiteboard page.

Detailed Description

Meeting UI Controller Interface.

Definition at line 235 of file meeting_ui_ctrl_interface.h.

Member Function Documentation

◆ BackToMeeting()

virtual SDKError IMeetingUIController::BackToMeeting ( )

pure virtual

Active the principal window of meeting and place it on top.

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

◆ CanSwapToShowShareViewOrVideo()

virtual SDKError IMeetingUIController::CanSwapToShowShareViewOrVideo ( bool & bCan )

pure virtual

Determine if the user can swap to show sharing screen or video now.

Parameters

[out] bCan TRUE means Can, otherwise not

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

◆ ChangeFloatToActiveSpkVideoSize()

virtual SDKError IMeetingUIController::ChangeFloatToActiveSpkVideoSize ( SDKFloatVideoType type )

pure virtual

Adjust the display mode of floating window.

Parameters

type	Specify the type of the floating video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ EnterFullScreen()

virtual SDKError IMeetingUIController::EnterFullScreen	(	bool	firstView,
		bool	secondView )

pure virtual

Enter full screen display mode.

Parameters

firstView	True indicates to enable the full screen mode for the first view.
secondView	True indicates to enable the full screen mode for the second view if it is in the dual view mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ ExitFullScreen()

virtual SDKError IMeetingUIController::ExitFullScreen	(	bool	firstView,
		bool	secondView )

pure virtual

Exit the full screen display mode.

Parameters

firstView	True indicates to exit the full screen mode for the first view.
secondView	True indicates to exit the full screen mode for the second view if it is in the dual view mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ GetCurrentSplitScreenModeInfo()

virtual SDKError IMeetingUIController::GetCurrentSplitScreenModeInfo ( SplitScreenInfo & info )

pure virtual

Get the information whether the current view supports split screen mode or not. If supports, check it if it is already in the split screen mode.

Parameters

[out] info If the function succeeds, the parameter will save the configuration of split screen mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ GetMeetingUIWnd()

virtual SDKError IMeetingUIController::GetMeetingUIWnd	(	HWND &	hFirstView,
		HWND &	hSecondView )

pure virtual

Get the window handle of the meeting user interface.

Parameters

[out]	hFirstView	If the function succeeds, the parameter will save the window handle of the meeting user interface displayed by the first view.
[out]	hSecondView	If the function succeeds, the parameter will save the window handle of the meeting user interface displayed by the second view.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ GetWallViewPageInfo()

virtual SDKError IMeetingUIController::GetWallViewPageInfo ( VideoWallPageInfoParam & videoWallPageInfoParam )

pure virtual

Get the information in video wall mode.

Parameters

[out] videoWallPageInfoParam If the function succeeds, the parameter will save the current page index and the number of the pages.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ HideChatDlg()

virtual SDKError IMeetingUIController::HideChatDlg ( )

pure virtual

Hide the chat dialog during the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ HideJoinAudioDlg()

virtual SDKError IMeetingUIController::HideJoinAudioDlg ( )

pure virtual

Hide the dialog to choose the audio to join the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ IsDisplayingShareViewOrVideo()

virtual SDKError IMeetingUIController::IsDisplayingShareViewOrVideo ( bool & bIsShare )

pure virtual

Determine if the meeting is displaying the sharing screen now.

Parameters

[out] bIsShare TRUE means is showing sharing screen, FALSE means is showing video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ IsMinimizeModeOfFirstScreenMeetingUIWnd()

virtual bool IMeetingUIController::IsMinimizeModeOfFirstScreenMeetingUIWnd ( SDKMinimizeUIMode & mode )

pure virtual

Determines the minimize state of the first view.

Parameters

[out] mode If the function succeeds, the parameter will save the display mode.

Returns: TRUE indicates the minimize state. FALSE not.

◆ MoveFloatVideoWnd()

virtual SDKError IMeetingUIController::MoveFloatVideoWnd	(	int	left,
		int	top )

pure virtual

Move the floating video window.

Parameters

left	Sets the left margin edge for the floating video window. Please use the coordinate of the screen.
top	Sets the top margin edge for the floating video window. Please use the coordinate of the screen.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SetCloudWhiteboardFeedbackUrl()

virtual SDKError IMeetingUIController::SetCloudWhiteboardFeedbackUrl ( const zchar_t * feedbackURL )

pure virtual

Set the feedback url in the whiteboard page.

Parameters

feedbackURL Specify the feedback url in the the whiteboard page.

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

◆ SetCustomizedCloudRecordingMgrUrl()

virtual SDKError IMeetingUIController::SetCustomizedCloudRecordingMgrUrl ( const zchar_t * crmURL )

pure virtual

Set the cloud recording manage url in the recording setting page.

Parameters

crmURL Specify the cloud recording manage url in the recording setting page.

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

◆ SetCustomizedInvitationDomain()

virtual SDKError IMeetingUIController::SetCustomizedInvitationDomain ( const zchar_t * invitation_domain )

pure virtual

Set the invitation domain.

Parameters

invitation_domain Specify the invitation domain.

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

◆ SetCustomizedPollingUrl()

virtual SDKError IMeetingUIController::SetCustomizedPollingUrl	(	const zchar_t *	URL,
		bool	bCreate )

pure virtual

Allowing the developer to customize the URL of create/edit the polling.

Parameters

URL	customized URL.
bCreate	When bCreate is true, it changes the URL of creating a polling. Otherwise, it changes the URL of editing a polling..

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

◆ SetEvent()

virtual SDKError IMeetingUIController::SetEvent ( IMeetingUIControllerEvent * pEvent )

pure virtual

Set meeting UI controller callback event handler.

Parameters

pEvent A pointer to the IMeetingUIControllerEvent that receives the meeting user interface event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SetMeetingTopic()

virtual SDKError IMeetingUIController::SetMeetingTopic ( const zchar_t * meetingtopic )

pure virtual

Set the meeting topic in the meeting information page.

Parameters

meetingtopic Specify the meeting topic in the meeting information page.

Returns: SDKErr_Success means success, otherwise not Otherwise failed.

Deprecated: This interface is marked as deprecated, and is replaced by IMeetingService::SetMeetingTopic().

◆ ShowBottomFloatToolbarWnd()

virtual SDKError IMeetingUIController::ShowBottomFloatToolbarWnd ( bool bShow )

pure virtual

Display/hide the toolbar at the bottom of the meeting window.

Parameters

bShow TRUE indicates to display the toolbar.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: This function does not work if the user sets to hide the toolbar via IMeetingUIElemConfiguration::SetBottomFloatToolbarWndVisibility().

◆ ShowChatDlg()

virtual SDKError IMeetingUIController::ShowChatDlg ( ShowChatDlgParam & param )

pure virtual

Show the chat dialog during the meeting.

Parameters

param Specifies the way to show the chat dialog.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ ShowJoinAudioDlg()

virtual SDKError IMeetingUIController::ShowJoinAudioDlg ( )

pure virtual

Display the dialog to choose the audio to join the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ ShowParticipantsListWnd()

virtual SDKError IMeetingUIController::ShowParticipantsListWnd	(	bool	bShow,
		HWND &	hParticipantsListWnd )

pure virtual

Display/hide the window which is used to display the list of the participants.

Parameters

	bShow	TRUE indicates to display the list of the participants.
[out]	hParticipantsListWnd	This function will return the window handle if the bShow value is set to TRUE and API calls successfully.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ ShowPreOrNextPageVideo()

virtual SDKError IMeetingUIController::ShowPreOrNextPageVideo ( bool bPageUp )

pure virtual

Show the video users on previous page or next page in video wall mode.

Parameters

bPageUp TRUE indicates to show the video users on previous page, FALSE next page.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: The function does not work if the window shows the first or last page. The return value is SDKErr_Success in this case.

◆ ShowSharingFrameWindows()

virtual SDKError IMeetingUIController::ShowSharingFrameWindows ( bool bShow )

pure virtual

Set the visibility of the green frame when sharing the desktop.

Parameters

bShow TRUE indicates to display the frame. FALSE hide.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ ShowSharingToolbar()

virtual SDKError IMeetingUIController::ShowSharingToolbar ( bool bShow )

pure virtual

Enable or disable to display the floating sharing toolbar.

Parameters

bShow TRUE indicates to display the floating toolbar.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: This function works only in the share mode.

◆ SwapToShowShareViewOrVideo()

virtual SDKError IMeetingUIController::SwapToShowShareViewOrVideo ( bool bToDisplayShare )

pure virtual

when someone else shares, and meeting window is not full screen. you can call the api to switch video & share display postion.

Parameters

bToDisplayShare TRUE means to display share, otherwise video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SwitchFloatVideoToActiveSpkMod()

virtual SDKError IMeetingUIController::SwitchFloatVideoToActiveSpkMod ( )

pure virtual

Switch to current speaker mode on the floating window.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SwitchFloatVideoToGalleryMod()

virtual SDKError IMeetingUIController::SwitchFloatVideoToGalleryMod ( )

pure virtual

Switch to gallery view mode on the floating window.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SwitchMinimizeUIMode4FirstScreenMeetingUIWnd()

virtual SDKError IMeetingUIController::SwitchMinimizeUIMode4FirstScreenMeetingUIWnd ( SDKMinimizeUIMode mode )

pure virtual

Change the display mode of the minimized meeting window for the first view.

Parameters

mode	Specifies the minimized mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SwitchSplitScreenMode()

virtual SDKError IMeetingUIController::SwitchSplitScreenMode ( bool bSplit )

pure virtual

Switch to the split screen mode or cancel.

Parameters

bSplit TRUE indicates to switch to the split screen mode. FALSE cancel.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: TRUE does not work if it is in the split screen mode. FALSE does not work if it is not the split screen mode.

◆ SwitchToActiveSpeaker()

virtual SDKError IMeetingUIController::SwitchToActiveSpeaker ( )

pure virtual

Switch to the mode of showing the current speaker.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SwitchToVideoWall()

virtual SDKError IMeetingUIController::SwitchToVideoWall ( )

pure virtual

Switch to video wall mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Public Member Functions

Detailed Description

Member Function Documentation

◆ BackToMeeting()

◆ CanSwapToShowShareViewOrVideo()

◆ ChangeFloatToActiveSpkVideoSize()

◆ EnterFullScreen()

◆ ExitFullScreen()

◆ GetCurrentSplitScreenModeInfo()

◆ GetMeetingUIWnd()

◆ GetWallViewPageInfo()

◆ HideChatDlg()

◆ HideJoinAudioDlg()

◆ IsDisplayingShareViewOrVideo()

◆ IsMinimizeModeOfFirstScreenMeetingUIWnd()

◆ MoveFloatVideoWnd()

◆ SetCloudWhiteboardFeedbackUrl()

◆ SetCustomizedCloudRecordingMgrUrl()

◆ SetCustomizedInvitationDomain()

◆ SetCustomizedPollingUrl()

◆ SetEvent()

◆ SetMeetingTopic()

◆ ShowBottomFloatToolbarWnd()

◆ ShowChatDlg()

◆ ShowJoinAudioDlg()

◆ ShowParticipantsListWnd()

◆ ShowPreOrNextPageVideo()

◆ ShowSharingFrameWindows()

◆ ShowSharingToolbar()

◆ SwapToShowShareViewOrVideo()

◆ SwitchFloatVideoToActiveSpkMod()

◆ SwitchFloatVideoToGalleryMod()

◆ SwitchMinimizeUIMode4FirstScreenMeetingUIWnd()

◆ SwitchSplitScreenMode()

◆ SwitchToActiveSpeaker()

◆ SwitchToVideoWall()