ZOOM Windows SDK  5.2.42037.1112
meeting_ui_ctrl_interface.h
Go to the documentation of this file.
1 
6 #ifndef _MEETING_UI_CTRL_INTERFACE_H_
7 #define _MEETING_UI_CTRL_INTERFACE_H_
8 #include "..\zoom_sdk_def.h"
9 
10 BEGIN_ZOOM_SDK_NAMESPACE
16 {
20 };
21 
27 {
31 
36 typedef struct tagShowChatDlgParam
37 {
38  HWND hParent;
39  RECT rect;
40  HWND hChatWnd;
42  {
43  hParent = NULL;
44  hChatWnd = NULL;
45  rect.top = 0;
46  rect.bottom = 0;
47  rect.left = 0;
48  rect.right = 0;
49  }
51 
57 {
62 };
63 
69 {
74 };
75 
80 typedef struct tagSplitScreenInfo
81 {
85  {
86  bSupportSplitScreen = false;
87  bInSplitScreenMode = false;
88  }
90 
96 {
104 };
105 
111 {
112  unsigned int userid_MuteUnmute;
115  {
116  userid_MuteUnmute = 0;
118  }
119 
121 
125 {
126 public:
130  virtual void onInviteBtnClicked(bool& bHandled) = 0;
131 
134  virtual void onStartShareBtnClicked() = 0;
135 
138  virtual void onEndMeetingBtnClicked() = 0;
139 
142  virtual void onParticipantListBtnClicked() = 0;
143 
146  virtual void onCustomLiveStreamMenuClicked() = 0;
147 
149  virtual void onZoomInviteDialogFailed() = 0;
150 
153  virtual void onCCBTNClicked() = 0;
154 
157  virtual void onAudioBtnClicked(AudioBtnClickedCallbackInfo info) = 0;
158 
161  virtual void onAudioMenuBtnClicked() = 0;
162 
165  virtual void onBreakoutRoomBtnClicked() = 0;
166 
167 };
168 
172 {
173 public:
178  virtual SDKError SetEvent(IMeetingUIControllerEvent* pEvent) = 0;
179 
184  virtual SDKError ShowChatDlg(ShowChatDlgParam& param) = 0;
185 
189  virtual SDKError HideChatDlg() = 0;
190 
196  virtual SDKError EnterFullScreen(bool firstView, bool secondView) = 0;
197 
203  virtual SDKError ExitFullScreen(bool firstView, bool secondView) = 0;
204 
208  virtual SDKError BackToMeeting() = 0;
209 
213  virtual SDKError SwitchToVideoWall() = 0;
214 
218  virtual SDKError SwtichToAcitveSpeaker() = 0;
219 
225  virtual SDKError MoveFloatVideoWnd(int left, int top) = 0;
226 
232  virtual SDKError ShowSharingToolbar(bool bShow) = 0;
233 
238 
244 
249 
255  virtual SDKError ShowParticipantsListWnd(bool bShow, HWND& hParticipantsListWnd) = 0;
256 
262  virtual SDKError ShowBottomFloatToolbarWnd(bool bShow) = 0;
263 
269  virtual SDKError GetMeetingUIWnd(HWND& hFirstView, HWND& hSecondView) = 0;
270 
274  virtual SDKError ShowJoinAudioDlg() = 0;
275 
279  virtual SDKError HideJoinAudioDlg() = 0;
280 
285  virtual SDKError GetWallViewPageInfo(VideoWallPageInfoParam& videoWallPageInfoParam) = 0;
286 
292  virtual SDKError ShowPreOrNextPageVideo(bool bPageUp) = 0;
293 
298  virtual SDKError ShowSharingFrameWindows(bool bShow) = 0;
299 
304 
310 
316 
322  virtual SDKError SwitchSplitScreenMode(bool bSplit) = 0;
323 
328  virtual SDKError SwapToShowShareViewOrVideo(bool bToDisplayShare) = 0;
329 
334  virtual SDKError IsDisplayingShareViewOrVideo(bool& bIsShare) = 0;
335 
340  virtual SDKError CanSwapToShowShareViewOrVideo(bool& bCan) = 0;
341 
346  virtual SDKError SetMeetingTopic(const wchar_t* meetingtopic) = 0;
347 };
348 
349 END_ZOOM_SDK_NAMESPACE
350 #endif
virtual void onStartShareBtnClicked()=0
Callback event for clicking START SHARE button.
virtual void onParticipantListBtnClicked()=0
Callback event of clicking PRTICIPANT LIST button.
Type of list.
Definition: meeting_ui_ctrl_interface.h:58
Split screen mode information. Here are more detailed structural descriptions.
Definition: meeting_ui_ctrl_interface.h:80
Video wall mode.
Definition: meeting_ui_ctrl_interface.h:18
virtual void onCustomLiveStreamMenuClicked()=0
Callback event of clicking CUSTOME LIVE STREAM menu.
virtual void onZoomInviteDialogFailed()=0
Notification occurs only when the SDK fails to display the default ZOOM INVITE dialog.
SDKFloatVideoType
The user interface type of float video. Here are more detailed structural descriptions.
Definition: meeting_ui_ctrl_interface.h:56
virtual SDKError ShowPreOrNextPageVideo(bool bPageUp)=0
Show the video users on previous page or next page in video wall mode.
Need to join voip.
Definition: meeting_ui_ctrl_interface.h:101
AudioCallbackActionInfo
The action user suggested to take after getting the callback event "IMeetingUIControllerEvent::onAudi...
Definition: meeting_ui_ctrl_interface.h:95
virtual void onBreakoutRoomBtnClicked()=0
Callback event for clicking Breakout Room button in the meeting.
virtual SDKError SetMeetingTopic(const wchar_t *meetingtopic)=0
Set the meeting topic in the meeting information page.
virtual SDKError GetCurrentSplitScreenModeInfo(SplitScreenInfo &info)=0
Get the information whether the current view supports split screen mode or not. If supports...
Minimized mode for sharing.
Definition: meeting_ui_ctrl_interface.h:71
Show audio setting window.
Definition: meeting_ui_ctrl_interface.h:103
virtual SDKError ShowBottomFloatToolbarWnd(bool bShow)=0
Display/hide the toolbar at the bottom of the meeting window.
For initialization.
Definition: meeting_ui_ctrl_interface.h:17
virtual SDKError ShowParticipantsListWnd(bool bShow, HWND &hParticipantsListWnd)=0
Display/hide the window which is used to display the list of the participants.
virtual SDKError HideJoinAudioDlg()=0
Hide the dialog to choose the audio to join the meeting.
Mute or unmute some user's audio according to the "AudioBtnClickedCallbackInfo::userid_MuteUnmute".
Definition: meeting_ui_ctrl_interface.h:102
int nTotalPages
The total number of pages in video wall mode.
Definition: meeting_ui_ctrl_interface.h:29
virtual SDKError SwitchSplitScreenMode(bool bSplit)=0
Switch to the split screen mode or cancel.
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual void onAudioMenuBtnClicked()=0
Callback event for clicking Audio Menu button in the meeting.
virtual SDKError ExitFullScreen(bool firstView, bool secondView)=0
Exit the full screen display mode.
Meeting UI Controller Interface.
Definition: meeting_ui_ctrl_interface.h:171
virtual SDKError ShowSharingFrameWindows(bool bShow)=0
Set the visibility of the green frame when sharing the desktop.
Small.
Definition: meeting_ui_ctrl_interface.h:59
virtual SDKError ShowSharingToolbar(bool bShow)=0
Enable or disable to display the floating sharing toolbar.
RECT rect
Chat dialog position.
Definition: meeting_ui_ctrl_interface.h:39
virtual SDKError ShowJoinAudioDlg()=0
Display the dialog to choose the audio to join the meeting.
int nCurrentPage
The page in video wall mode for the moment.
Definition: meeting_ui_ctrl_interface.h:28
Minimized mode for speaking.
Definition: meeting_ui_ctrl_interface.h:73
Active user mode.
Definition: meeting_ui_ctrl_interface.h:19
virtual SDKError SwitchMinimizeUIMode4FristScreenMeetingUIWnd(SDKMinimizeUIMode mode)=0
Change the display mode of the minimized meeting window for the first view.
virtual SDKError GetWallViewPageInfo(VideoWallPageInfoParam &videoWallPageInfoParam)=0
Get the information in video wall mode.
For initialization.
Definition: meeting_ui_ctrl_interface.h:97
virtual SDKError SwitchFloatVideoToActiveSpkMod()=0
Switch to current speaker mode on the floating window.
virtual bool IsMinimizeModeOfFristScreenMeetingUIWnd(SDKMinimizeUIMode &mode)=0
Determines the minimize state of the first view.
SDKMeetingUIType
The displayed type of the user videos in the meeting. Here are more detailed structural descriptions...
Definition: meeting_ui_ctrl_interface.h:15
Minimized.
Definition: meeting_ui_ctrl_interface.h:61
SDKMinimizeUIMode
The type of minimize user interface mode. Here are more detailed structural descriptions.
Definition: meeting_ui_ctrl_interface.h:68
virtual void onAudioBtnClicked(AudioBtnClickedCallbackInfo info)=0
Callback event for clicking Audio button in the meeting.
virtual SDKError MoveFloatVideoWnd(int left, int top)=0
Move the floating video window.
Choose audio device because there is an error in the connected computer audio device.
Definition: meeting_ui_ctrl_interface.h:99
virtual SDKError SwitchFloatVideoToGalleryMod()=0
Switch to gallery view mode on the floating window.
bool bInSplitScreenMode
In the process of displaying the video in the row.
Definition: meeting_ui_ctrl_interface.h:83
unsigned int userid_MuteUnmute
The id of the user that should be muted or unmuted. When no mute or unmute operation is required...
Definition: meeting_ui_ctrl_interface.h:112
virtual SDKError CanSwapToShowShareViewOrVideo(bool &bCan)=0
Determine if the user can swap to show sharing screen or video now.
Large.
Definition: meeting_ui_ctrl_interface.h:60
virtual SDKError HideChatDlg()=0
Hide the chat dialog during the meeting.
virtual SDKError GetMeetingUIWnd(HWND &hFirstView, HWND &hSecondView)=0
Get the window handle of the meeting user interface.
virtual SDKError BackToMeeting()=0
Active the principal window of meeting and place it on top.
virtual void onInviteBtnClicked(bool &bHandled)=0
Callback event to click the INVITE button.
virtual SDKError SwtichToAcitveSpeaker()=0
Switch to the mode of showing the current speaker.
virtual SDKError SwitchToVideoWall()=0
Switch to video wall mode.
HWND hChatWnd
Chat dialog handle.
Definition: meeting_ui_ctrl_interface.h:40
Choose audio device because there is an error in the connected phone call device. ...
Definition: meeting_ui_ctrl_interface.h:100
virtual SDKError ChangeFloatoActiveSpkVideoSize(SDKFloatVideoType type)=0
Adjust the display mode of floating window.
AudioCallbackActionInfo audio_clicked_action
The suggested action for user to take.
Definition: meeting_ui_ctrl_interface.h:113
virtual void onCCBTNClicked()=0
Callback event of clicking CC menu.
Callback Event of Meeting UI Controller.
Definition: meeting_ui_ctrl_interface.h:124
virtual void onEndMeetingBtnClicked()=0
Callback event of clicking the END MEETING button.
Minimized mode for video.
Definition: meeting_ui_ctrl_interface.h:72
The suggested action information for user to handle after getting the callback event "IMeetingUIContr...
Definition: meeting_ui_ctrl_interface.h:110
virtual SDKError SetEvent(IMeetingUIControllerEvent *pEvent)=0
Set meeting UI controller callback event handler.
bool bSupportSplitScreen
Support display the video in a row.
Definition: meeting_ui_ctrl_interface.h:82
For initialization.
Definition: meeting_ui_ctrl_interface.h:70
virtual SDKError ShowChatDlg(ShowChatDlgParam &param)=0
Show the chat dialog during the meeting.
HWND hParent
Parent window handle.
Definition: meeting_ui_ctrl_interface.h:38
virtual SDKError EnterFullScreen(bool firstView, bool secondView)=0
Enter full screen display mode.
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...
Video wall page information. Here are more detailed structural descriptions.
Definition: meeting_ui_ctrl_interface.h:26
Choose audio device because no audio device is connected yet.
Definition: meeting_ui_ctrl_interface.h:98
The configuration of the parameters to display the dialog. Here are more detailed structural descript...
Definition: meeting_ui_ctrl_interface.h:36
virtual SDKError IsDisplayingShareViewOrVideo(bool &bIsShare)=0
Determine if the meeting is displaying the sharing screen now.