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
24
42
47typedef struct tagShowChatDlgParam
48{
50 HWND hParent;
52 RECT rect;
56 {
57 hParent = nullptr;
58 hChatWnd = nullptr;
59 rect.top = 0;
60 rect.bottom = 0;
61 rect.left = 0;
62 rect.right = 0;
63 }
65
81
97
114
136
159{
160public:
162
168 virtual void onInviteBtnClicked(bool& bHandled) = 0;
169
175 virtual void onStartShareBtnClicked() = 0;
176
182 virtual void onEndMeetingBtnClicked() = 0;
183
189 virtual void onParticipantListBtnClicked() = 0;
190
197
201 virtual void onZoomInviteDialogFailed() = 0;
202
207 virtual void onCCBTNClicked() = 0;
208
215
221 virtual void onAudioMenuBtnClicked() = 0;
222
228 virtual void onBreakoutRoomBtnClicked() = 0;
229
230};
236{
237public:
244
251
256 virtual SDKError HideChatDlg() = 0;
257
264 virtual SDKError EnterFullScreen(bool firstView, bool secondView) = 0;
265
272 virtual SDKError ExitFullScreen(bool firstView, bool secondView) = 0;
273
278 virtual SDKError BackToMeeting() = 0;
279
285
291
298 virtual SDKError MoveFloatVideoWnd(int left, int top) = 0;
299
306 virtual SDKError ShowSharingToolbar(bool bShow) = 0;
307
313
320
326
333 virtual SDKError ShowParticipantsListWnd(bool bShow, HWND& hParticipantsListWnd) = 0;
334
341 virtual SDKError ShowBottomFloatToolbarWnd(bool bShow) = 0;
342
349 virtual SDKError GetMeetingUIWnd(HWND& hFirstView, HWND& hSecondView) = 0;
350
356
362
368 virtual SDKError GetWallViewPageInfo(VideoWallPageInfoParam& videoWallPageInfoParam) = 0;
369
376 virtual SDKError ShowPreOrNextPageVideo(bool bPageUp) = 0;
377
383 virtual SDKError ShowSharingFrameWindows(bool bShow) = 0;
384
391
398
405
412 virtual SDKError SwitchSplitScreenMode(bool bSplit) = 0;
413
419 virtual SDKError SwapToShowShareViewOrVideo(bool bToDisplayShare) = 0;
420
426 virtual SDKError IsDisplayingShareViewOrVideo(bool& bIsShare) = 0;
427
434
441 virtual SDKError SetMeetingTopic(const zchar_t* meetingtopic) = 0;
442
449
455 virtual SDKError SetCustomizedInvitationDomain(const zchar_t* invitation_domain) = 0;
456
463 virtual SDKError SetCustomizedPollingUrl(const zchar_t* URL, bool bCreate) = 0;
464
470 virtual SDKError SetCloudWhiteboardFeedbackUrl(const zchar_t* feedbackURL) = 0;
471};
472
474#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_ACTIVESPEAKER
struct tagSplitScreenInfo SplitScreenInfo
Split screen mode information. Here are more detailed structural descriptions.
struct tagShowChatDlgParam ShowChatDlgParam
The configuration of the parameters to display the dialog. Here are more detailed structural descript...
SDKFloatVideoType
The user interface type of float video. Here are more detailed structural descriptions.
struct tagAudioBtnClickedCallbackInfo AudioBtnClickedCallbackInfo
The suggested action information for user to handle after getting the callback event "IMeetingUIContr...
AudioCallbackActionInfo
The action user suggested to take after getting the callback event "IMeetingUIControllerEvent::onAudi...
@ ACTION_CHOOSE_AUDIO_DEVICE_COMPUTERAUDIODEVICEERROR
@ ACTION_CHOOSE_AUDIO_DEVICE_PHONECALLDEVICEERROR
@ ACTION_SHOW_AUDIO_SETTING_WINDOW
@ ACTION_CHOOSE_AUDIO_DEVICE_NOAUDIODEVICECONNECTTED
@ ACTION_MUTE_UNMUTE_AUDIO
struct tagVideoWallPageInfoParam VideoWallPageInfoParam
Video wall page information. Here are more detailed structural descriptions.
SDKMeetingUIType
The displayed type of the user videos in the meeting. Here are more detailed structural descriptions.
@ SDK_Meeting_UI_ActiveRender_Mode
@ SDK_Meeting_UI_VideoWall_Mode
The suggested action information for user to handle after getting the callback event "IMeetingUIContr...
The configuration of the parameters to display the dialog. Here are more detailed structural descript...
Split screen mode information. Here are more detailed structural descriptions.
Video wall page information. Here are more detailed structural descriptions.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
Definition zoom_sdk_def.h:9
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.