Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
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
21
37
42typedef struct tagShowChatDlgParam
43{
44 HWND hParent;
45 RECT rect;
48 {
49 hParent = nullptr;
50 hChatWnd = nullptr;
51 rect.top = 0;
52 rect.bottom = 0;
53 rect.left = 0;
54 rect.right = 0;
55 }
57
69
81
96
111
127
131{
132public:
134
138 virtual void onInviteBtnClicked(bool& bHandled) = 0;
139
142 virtual void onStartShareBtnClicked() = 0;
143
146 virtual void onEndMeetingBtnClicked() = 0;
147
150 virtual void onParticipantListBtnClicked() = 0;
151
155
157 virtual void onZoomInviteDialogFailed() = 0;
158
161 virtual void onCCBTNClicked() = 0;
162
166
169 virtual void onAudioMenuBtnClicked() = 0;
170
173 virtual void onBreakoutRoomBtnClicked() = 0;
174
175};
176
180{
181public:
187
193
197 virtual SDKError HideChatDlg() = 0;
198
204 virtual SDKError EnterFullScreen(bool firstView, bool secondView) = 0;
205
211 virtual SDKError ExitFullScreen(bool firstView, bool secondView) = 0;
212
216 virtual SDKError BackToMeeting() = 0;
217
222
227
233 virtual SDKError MoveFloatVideoWnd(int left, int top) = 0;
234
240 virtual SDKError ShowSharingToolbar(bool bShow) = 0;
241
246
252
257
263 virtual SDKError ShowParticipantsListWnd(bool bShow, HWND& hParticipantsListWnd) = 0;
264
270 virtual SDKError ShowBottomFloatToolbarWnd(bool bShow) = 0;
271
277 virtual SDKError GetMeetingUIWnd(HWND& hFirstView, HWND& hSecondView) = 0;
278
283
288
293 virtual SDKError GetWallViewPageInfo(VideoWallPageInfoParam& videoWallPageInfoParam) = 0;
294
300 virtual SDKError ShowPreOrNextPageVideo(bool bPageUp) = 0;
301
306 virtual SDKError ShowSharingFrameWindows(bool bShow) = 0;
307
312
318
324
330 virtual SDKError SwitchSplitScreenMode(bool bSplit) = 0;
331
336 virtual SDKError SwapToShowShareViewOrVideo(bool bToDisplayShare) = 0;
337
342 virtual SDKError IsDisplayingShareViewOrVideo(bool& bIsShare) = 0;
343
349
355 virtual SDKError SetMeetingTopic(const zchar_t* meetingtopic) = 0;
356
362
367 virtual SDKError SetCustomizedInvitationDomain(const zchar_t* invitation_domain) = 0;
368
374 virtual SDKError SetCustomizedPollingUrl(const zchar_t* URL, bool bCreate) = 0;
375
380 virtual SDKError SetCloudWhiteboardFeedbackUrl(const zchar_t* feedbackURL) = 0;
381};
382
384#endif
Callback Event of Meeting UI Controller.
virtual void onStartShareBtnClicked()=0
Callback event for clicking START SHARE button.
virtual void onAudioBtnClicked(AudioBtnClickedCallbackInfo info)=0
Callback event for clicking Audio button in the meeting.
virtual void onInviteBtnClicked(bool &bHandled)=0
Callback event to click the INVITE button.
virtual void onCCBTNClicked()=0
Callback event of clicking CC menu.
virtual void onAudioMenuBtnClicked()=0
Callback event for clicking Audio Menu button in the meeting.
virtual void onBreakoutRoomBtnClicked()=0
Callback event for clicking Breakout Room button in the meeting.
virtual void onParticipantListBtnClicked()=0
Callback event of clicking PRTICIPANT LIST button.
virtual void onZoomInviteDialogFailed()=0
Notification occurs only when the SDK fails to display the default ZOOM INVITE dialog.
virtual void onCustomLiveStreamMenuClicked()=0
Callback event of clicking CUSTOME LIVE STREAM menu.
virtual void onEndMeetingBtnClicked()=0
Callback event of clicking the END MEETING button.
Meeting UI Controller Interface.
virtual SDKError EnterFullScreen(bool firstView, bool secondView)=0
Enter full screen display mode.
virtual SDKError SwitchToVideoWall()=0
Switch to video wall mode.
virtual SDKError GetMeetingUIWnd(HWND &hFirstView, HWND &hSecondView)=0
Get the window handle of the meeting user interface.
virtual SDKError IsDisplayingShareViewOrVideo(bool &bIsShare)=0
Determine if the meeting is displaying the sharing screen now.
virtual SDKError ShowSharingToolbar(bool bShow)=0
Enable or disable to display the floating sharing toolbar.
virtual SDKError SwitchMinimizeUIMode4FirstScreenMeetingUIWnd(SDKMinimizeUIMode mode)=0
Change the display mode of the minimized meeting window for the first view.
virtual SDKError ShowBottomFloatToolbarWnd(bool bShow)=0
Display/hide the toolbar at the bottom of the meeting window.
virtual SDKError ShowChatDlg(ShowChatDlgParam &param)=0
Show the chat dialog during the meeting.
virtual SDKError SetCustomizedPollingUrl(const zchar_t *URL, bool bCreate)=0
Allowing the developer to customize the URL of create/edit the polling.
virtual SDKError ChangeFloatToActiveSpkVideoSize(SDKFloatVideoType type)=0
Adjust the display mode of floating window.
virtual SDKError ShowPreOrNextPageVideo(bool bPageUp)=0
Show the video users on previous page or next page in video wall mode.
virtual SDKError SetMeetingTopic(const zchar_t *meetingtopic)=0
Set the meeting topic in the meeting information page.
virtual SDKError SwitchSplitScreenMode(bool bSplit)=0
Switch to the split screen mode or cancel.
virtual SDKError SetCustomizedCloudRecordingMgrUrl(const zchar_t *crmURL)=0
Set the cloud recording manage url in the recording setting page.
virtual SDKError HideJoinAudioDlg()=0
Hide the dialog to choose the audio to join the meeting.
virtual SDKError CanSwapToShowShareViewOrVideo(bool &bCan)=0
Determine if the user can swap to show sharing screen or video now.
virtual SDKError GetCurrentSplitScreenModeInfo(SplitScreenInfo &info)=0
Get the information whether the current view supports split screen mode or not. If supports,...
virtual SDKError MoveFloatVideoWnd(int left, int top)=0
Move the floating video window.
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...
virtual SDKError SetCloudWhiteboardFeedbackUrl(const zchar_t *feedbackURL)=0
Set the feedback url in the whiteboard page.
virtual SDKError GetWallViewPageInfo(VideoWallPageInfoParam &videoWallPageInfoParam)=0
Get the information in video wall mode.
virtual SDKError ShowJoinAudioDlg()=0
Display the dialog to choose the audio to join the meeting.
virtual SDKError HideChatDlg()=0
Hide the chat dialog during the meeting.
virtual SDKError SwitchToActiveSpeaker()=0
Switch to the mode of showing the current speaker.
virtual SDKError SetEvent(IMeetingUIControllerEvent *pEvent)=0
Set meeting UI controller callback event handler.
virtual bool IsMinimizeModeOfFirstScreenMeetingUIWnd(SDKMinimizeUIMode &mode)=0
Determines the minimize state of the first view.
virtual SDKError SwitchFloatVideoToGalleryMod()=0
Switch to gallery view mode on the floating window.
virtual SDKError ShowSharingFrameWindows(bool bShow)=0
Set the visibility of the green frame when sharing the desktop.
virtual SDKError SetCustomizedInvitationDomain(const zchar_t *invitation_domain)=0
Set the invitation domain.
virtual SDKError SwitchFloatVideoToActiveSpkMod()=0
Switch to current speaker mode on the floating window.
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 ShowParticipantsListWnd(bool bShow, HWND &hParticipantsListWnd)=0
Display/hide the window which is used to display the list of the participants.
SDKMinimizeUIMode
The type of minimize user interface mode. Here are more detailed structural descriptions.
@ MinimizeUIMode_VIDEO
Minimized mode for video.
@ MinimizeUIMode_NONE
For initialization.
@ MinimizeUIMode_SHARE
Minimized mode for sharing.
@ MinimizeUIMode_ACTIVESPEAKER
Minimized mode for speaking.
struct tagSplitScreenInfo SplitScreenInfo
struct tagShowChatDlgParam ShowChatDlgParam
SDKFloatVideoType
The user interface type of float video. Here are more detailed structural descriptions.
@ FLOATVIDEO_Minimize
Minimized.
@ FLOATVIDEO_List
Type of list.
@ FLOATVIDEO_Large
Large.
@ FLOATVIDEO_Small
Small.
struct tagAudioBtnClickedCallbackInfo AudioBtnClickedCallbackInfo
AudioCallbackActionInfo
The action user suggested to take after getting the callback event "IMeetingUIControllerEvent::onAudi...
@ ACTION_CHOOSE_AUDIO_DEVICE_COMPUTERAUDIODEVICEERROR
Choose audio device because there is an error in the connected computer audio device.
@ ACTION_CHOOSE_AUDIO_DEVICE_PHONECALLDEVICEERROR
Choose audio device because there is an error in the connected phone call device.
@ ACTION_NEED_JOIN_VOIP
Need to join voip.
@ ACTION_SHOW_AUDIO_SETTING_WINDOW
Show audio setting window.
@ ACTION_NONE
For initialization.
@ ACTION_CHOOSE_AUDIO_DEVICE_NOAUDIODEVICECONNECTTED
Choose audio device because no audio device is connected yet.
@ ACTION_MUTE_UNMUTE_AUDIO
Mute or unmute some user's audio according to the "AudioBtnClickedCallbackInfo::userid_MuteUnmute".
struct tagVideoWallPageInfoParam VideoWallPageInfoParam
SDKMeetingUIType
The displayed type of the user videos in the meeting. Here are more detailed structural descriptions.
@ SDK_Meeting_UI_ActiveRender_Mode
Active user mode.
@ SDK_Meeting_UI_VideoWall_Mode
Video wall mode.
@ SDK_Meeting_UI_None
For initialization.
The suggested action information for user to handle after getting the callback event "IMeetingUIContr...
unsigned int userid_MuteUnmute
The id of the user that should be muted or unmuted. When no mute or unmute operation is required,...
AudioCallbackActionInfo audio_clicked_action
The suggested action for user to take.
The configuration of the parameters to display the dialog. Here are more detailed structural descript...
HWND hParent
Parent window handle.
RECT rect
Chat dialog position.
HWND hChatWnd
Chat dialog handle.
Split screen mode information. Here are more detailed structural descriptions.
bool bSupportSplitScreen
Support display the video in a row.
bool bInSplitScreenMode
In the process of displaying the video in the row.
Video wall page information. Here are more detailed structural descriptions.
int nCurrentPage
The page in video wall mode for the moment.
int nTotalPages
The total number of pages in video wall mode.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.