Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_whiteboard_ctrl_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_WHITEBOARD_CTRL_INTERFACE_H_
6#define _MEETING_WHITEBOARD_CTRL_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
10
20
30
39
43{
44public:
53 virtual void onWhiteboardSettingsChanged(SDKWhiteboardShareOption shareOption, SDKWhiteboardCreateOption createOption, bool bEnable) = 0;
54};
55
58{
59public:
66
74 virtual SDKError SetOwnerWindow(HWND hOwner) = 0;
75
76 // \brief Determine whether the current meeting supports the whiteboard or not.
78 virtual bool IsSupportWhiteBoard() = 0;
79
84
92 virtual SDKError ShowDashboardView(int x = -1, int y = -1) = 0;
93
101 virtual SDKError SetDashboardViewSize(int width = -1, int height = -1) = 0;
102
111 virtual SDKError SetWhiteboardViewPos(int x = -1, int y = -1) = 0;
112
121 virtual SDKError SetWhiteboardViewSize(int width = -1, int height = -1) = 0;
122
128
134
140
146
152
153 // \brief Determine whether enable the participants create a new whiteboard without the host in the meeting.
156
159 virtual bool IsOtherSharingWhiteboard() = 0;
160
163 virtual bool IsSharingWhiteboardOut() = 0;
164};
165
167#endif
virtual bool IsOtherSharingWhiteboard()=0
Query if other user is sharing whiteboard.
virtual SDKError SetDashboardViewSize(int width=-1, int height=-1)=0
Set the dashboard web view window size.
virtual bool IsSupportWhiteBoard()=0
virtual bool CanStartShareWhiteboard(CannotShareReasonType &reason)=0
Determine whether the current meeting can start sharing the whiteboard.
virtual SDKError SetWhiteboardShareOption(SDKWhiteboardShareOption option)=0
Set the option for who can share a whiteboard.
virtual SDKError SetOwnerWindow(HWND hOwner)=0
Set the whiteboard web view and dashboard web view owner window.
virtual SDKError SetEvent(IMeetingWhiteboardCtrlEvent *pEvent)=0
Configure the meeting whiteboard controller callback event handler.
virtual SDKError GetWhiteboardCreateOption(SDKWhiteboardCreateOption &option)=0
Get the option for who can initiate a new whiteboard.
virtual SDKError EnableParticipantsCreateWithoutHost(bool bEnable)=0
Enable the participants to create a new whiteboard without the host in the meeting.
virtual SDKError SetWhiteboardViewPos(int x=-1, int y=-1)=0
Set the whiteboard web view window position.
virtual SDKError SetWhiteboardViewSize(int width=-1, int height=-1)=0
Set the whiteboard web view window size.
virtual SDKError GetWhiteboardShareOption(SDKWhiteboardShareOption &option)=0
Get the option for who can share a whiteboard.
virtual SDKError ShowDashboardView(int x=-1, int y=-1)=0
Show the dashboard web view window.
virtual bool IsParticipantsCreateWithoutHostEnabled()=0
virtual bool IsSharingWhiteboardOut()=0
Query if the current user is sharing whiteboard successfully.
virtual SDKError SetWhiteboardCreateOption(SDKWhiteboardCreateOption option)=0
Set the option for who can initiate a new whiteboard.
Whiteboard controller callback event.
virtual void onWhiteboardSettingsChanged(SDKWhiteboardShareOption shareOption, SDKWhiteboardCreateOption createOption, bool bEnable)=0
Callback event of whiteboard setting type changed.
virtual void onWhiteboardStatusChanged(SDKWhiteboardStatus status)=0
Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been...
SDKWhiteboardCreateOption
Whiteboard who can initiate new whiteboard setting type.
@ SDKWhiteboardCreateOption_All
All participants can initiate a new whiteboard.
@ SDKWhiteboardCreateOption_AccountUsers
Users under the same account as the meeting owner can initiate a new whiteboard.
@ SDKWhiteboardCreateOption_HostOnly
Only the host can initiate a new whiteboard.
SDKWhiteboardShareOption
Whiteboard who can share setting type.
@ SDKWhiteboardShareOption_HostShare
Only the host can share a whiteboard.
@ SDKWhiteboardShareOption_HostGrabShare
Anyone can share a whiteboard, but only one can share at a time, and only the host can take another's...
@ SDKWhiteboardShareOption_AllGrabShare
Anyone can share a whiteboard, but only one can share at a time, and anyone can take another's sharin...
@ SDKWhiteboardStatus_Stopped
User stopped sharing their whiteboard.
@ SDKWhiteboardStatus_Started
User stared sharing their whiteboard.
ZOOM windows SDK Common Definition File.
CannotShareReasonType
Enumeration of reasons why sharing is not allowed.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.