ZOOM Windows SDK  5.0.24433.0616
Public Member Functions | List of all members
IMeetingUIController Class Referenceabstract

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. More...
 
virtual SDKError ShowChatDlg (ShowChatDlgParam &param)=0
 Show the chat dialog during the meeting. More...
 
virtual SDKError HideChatDlg ()=0
 Hide the chat dialog during the meeting. More...
 
virtual SDKError EnterFullScreen (bool firstView, bool secondView)=0
 Enter full screen display mode. More...
 
virtual SDKError ExitFullScreen (bool firstView, bool secondView)=0
 Exit the full screen display mode. More...
 
virtual SDKError BackToMeeting ()=0
 Active the principal window of meeting and place it on top. More...
 
virtual SDKError SwitchToVideoWall ()=0
 Switch to video wall mode. More...
 
virtual SDKError SwtichToAcitveSpeaker ()=0
 Switch to the mode of showing the current speaker. More...
 
virtual SDKError MoveFloatVideoWnd (int left, int top)=0
 Move the floating video window. More...
 
virtual SDKError ShowSharingToolbar (bool bShow)=0
 Enable or disable to display the floating sharing toolbar. More...
 
virtual SDKError SwitchFloatVideoToActiveSpkMod ()=0
 Switch to current speaker mode on the floating window. More...
 
virtual SDKError ChangeFloatoActiveSpkVideoSize (SDKFloatVideoType type)=0
 Adjust the display mode of floating window. More...
 
virtual SDKError SwitchFloatVideoToGalleryMod ()=0
 Switch to gallery view mode on the floating window. More...
 
virtual SDKError ShowParticipantsListWnd (bool bShow, HWND &hParticipantsListWnd)=0
 Display/hide the window which is used to display the list of the participants. More...
 
virtual SDKError ShowBottomFloatToolbarWnd (bool bShow)=0
 Display/hide the toolbar at the bottom of the meeting window. More...
 
virtual SDKError GetMeetingUIWnd (HWND &hFirstView, HWND &hSecondView)=0
 Get the window handle of the meeting user interface. More...
 
virtual SDKError ShowJoinAudioDlg ()=0
 Display the dialog to choose the audio to join the meeting. More...
 
virtual SDKError HideJoinAudioDlg ()=0
 Hide the dialog to choose the audio to join the meeting. More...
 
virtual SDKError GetWallViewPageInfo (VideoWallPageInfoParam &videoWallPageInfoParam)=0
 Get the information in video wall mode. More...
 
virtual SDKError ShowPreOrNextPageVideo (bool bPageUp)=0
 Show the video users on previous page or next page in video wall mode. More...
 
virtual SDKError ShowSharingFrameWindows (bool bShow)=0
 Set the visibility of the green frame when sharing the application. More...
 
virtual bool IsMinimizeModeOfFristScreenMeetingUIWnd (SDKMinimizeUIMode &mode)=0
 Determines the minimize state of the first view. More...
 
virtual SDKError SwitchMinimizeUIMode4FristScreenMeetingUIWnd (SDKMinimizeUIMode mode)=0
 Change the display mode of the minimized meeting window for the first view. More...
 
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. More...
 
virtual SDKError SwitchSplitScreenMode (bool bSplit)=0
 Switch to the split screen mode or cancel. More...
 
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. More...
 
virtual SDKError IsDisplayingShareViewOrVideo (bool &bIsShare)=0
 Determine if the meeting is displaying the sharing screen now. More...
 
virtual SDKError CanSwapToShowShareViewOrVideo (bool &bCan)=0
 Determine if the user can swap to show sharing screen or video now. More...
 
virtual SDKError SetMeetingTopic (const wchar_t *meetingtopic)=0
 Set the meeting topic in the meeting information page. More...
 

Detailed Description

Meeting UI Controller Interface.

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]bCanTRUE means Can, otherwise not
Returns
SDKErr_Success means success, otherwise not Otherwise failed. To get extended error information, see SDKError enum.

◆ ChangeFloatoActiveSpkVideoSize()

virtual SDKError IMeetingUIController::ChangeFloatoActiveSpkVideoSize ( SDKFloatVideoType  type)
pure virtual

Adjust the display mode of floating window.

Parameters
typeSpecify the type of the floating video. For more details, see SDKFloatVideoType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnterFullScreen()

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

Enter full screen display mode.

Parameters
firstViewTrue indicates to enable the full screen mode for the first view.
secondViewTrue 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. To get extended error information, see SDKError enum.

◆ ExitFullScreen()

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

Exit the full screen display mode.

Parameters
firstViewTrue indicates to exit the full screen mode for the first view.
secondViewTrue 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. To get extended error information, see SDKError enum.

◆ 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]infoIf the function succeeds, the parameter will save the configuration of split screen mode. For more details, see SplitScreenInfo enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetMeetingUIWnd()

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

Get the window handle of the meeting user interface.

Parameters
[out]hFirstViewIf the function succeeds, the parameter will save the window handle of the meeting user interface displayed by the first view.
[out]hSecondViewIf 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. To get extended error information, see SDKError enum.

◆ GetWallViewPageInfo()

virtual SDKError IMeetingUIController::GetWallViewPageInfo ( VideoWallPageInfoParam videoWallPageInfoParam)
pure virtual

Get the information in video wall mode.

Parameters
[out]videoWallPageInfoParamIf the function succeeds, the parameter will save the current page index and the number of the pages. For more details, see VideoWallPageInfoParam structure.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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. To get extended error information, see SDKError enum.

◆ 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. To get extended error information, see SDKError enum.

◆ IsDisplayingShareViewOrVideo()

virtual SDKError IMeetingUIController::IsDisplayingShareViewOrVideo ( bool &  bIsShare)
pure virtual

Determine if the meeting is displaying the sharing screen now.

Parameters
[out]bIsShareTRUE means is showing sharing screen, FALSE means is showing video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ IsMinimizeModeOfFristScreenMeetingUIWnd()

virtual bool IMeetingUIController::IsMinimizeModeOfFristScreenMeetingUIWnd ( SDKMinimizeUIMode mode)
pure virtual

Determines the minimize state of the first view.

Parameters
[out]modeIf the function succeeds, the parameter will save the display mode. For more details, see SDKMinimizeUIMode enum.
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
leftSets the left margin edge for the floating video window. Please use the coordinate of the screen.
topSets 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. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IMeetingUIController::SetEvent ( IMeetingUIControllerEvent pEvent)
pure virtual

Set meeting UI controller callback event handler.

Parameters
pEventA pointer to the IMeetingUIControllerEvent that receives the meeting user interface event. For more details, see IMeetingUIControllerEvent.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetMeetingTopic()

virtual SDKError IMeetingUIController::SetMeetingTopic ( const wchar_t *  meetingtopic)
pure virtual

Set the meeting topic in the meeting information page.

Parameters
meetingtopicSpecify the meeting topic in the meeting information page.
Returns
SDKErr_Success means success, otherwise not Otherwise failed. To get extended error information, see SDKError enum.

◆ ShowBottomFloatToolbarWnd()

virtual SDKError IMeetingUIController::ShowBottomFloatToolbarWnd ( bool  bShow)
pure virtual

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

Parameters
bShowTRUE indicates to display the toolbar.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
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
paramSpecifies the way to show the chat dialog. For more details, see ShowChatDlgParam structure.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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. To get extended error information, see SDKError enum.

◆ 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
bShowTRUE indicates to display the list of the participants.
[out]hParticipantsListWndThis 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. To get extended error information, see SDKError enum.

◆ ShowPreOrNextPageVideo()

virtual SDKError IMeetingUIController::ShowPreOrNextPageVideo ( bool  bPageUp)
pure virtual

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

Parameters
bPageUpTRUE 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. To get extended error information, see SDKError enum.
Remarks
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 application.

Parameters
bShowTRUE indicates to display the frame. FALSE hide.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ ShowSharingToolbar()

virtual SDKError IMeetingUIController::ShowSharingToolbar ( bool  bShow)
pure virtual

Enable or disable to display the floating sharing toolbar.

Parameters
bShowTRUE indicates to display the floating toolbar.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
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
bToDisplayShareTRUE means to display share, otherwise video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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. To get extended error information, see SDKError enum.

◆ 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. To get extended error information, see SDKError enum.

◆ SwitchMinimizeUIMode4FristScreenMeetingUIWnd()

virtual SDKError IMeetingUIController::SwitchMinimizeUIMode4FristScreenMeetingUIWnd ( SDKMinimizeUIMode  mode)
pure virtual

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

Parameters
modeSpecifies the minimized mode. For more details, see SDKMinimizeUIMode enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SwitchSplitScreenMode()

virtual SDKError IMeetingUIController::SwitchSplitScreenMode ( bool  bSplit)
pure virtual

Switch to the split screen mode or cancel.

Parameters
bSplitTRUE indicates to switch to the split screen mode. FALSE cancel.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
TRUE does not work if it is in the split screen mode. FALSE does not work if it is not the split screen mode.

◆ 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. To get extended error information, see SDKError enum.

◆ SwtichToAcitveSpeaker()

virtual SDKError IMeetingUIController::SwtichToAcitveSpeaker ( )
pure virtual

Switch to the mode of showing the current speaker.

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

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