Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_annotation_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_Annotation_INTERFACE_H_
7#define _MEETING_Annotation_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
80
86{
87public:
91 virtual void onSupportAnnotationStatus(unsigned int nShareSourceID, bool bSupportAnnotation) = 0;
92
94};
95
102{
103public:
110
115 virtual bool IsAnnotationDisable() = 0;
124 virtual SDKError StartAnnotation(SDKViewType viewtype) = 0;
131 virtual SDKError StopAnnotation(SDKViewType viewtype) = 0;
139 virtual SDKError SetTool(SDKViewType viewtype, AnnotationToolType type) = 0;
147 virtual SDKError Clear(SDKViewType viewtype, AnnotationClearType type) = 0;
148
156 virtual SDKError SetColor(SDKViewType viewtype, unsigned long color) = 0;
164 virtual SDKError SetLineWidth(SDKViewType viewtype, long lineWidth) = 0;
165
172 virtual SDKError Undo(SDKViewType viewtype) = 0;
173
180 virtual SDKError Redo(SDKViewType viewtype) = 0;
181
188
195 virtual SDKError DisableViewerAnnotation(SDKViewType viewtype, bool bDisable) = 0;
196
203 virtual SDKError IsViewerAnnotationDisabled(SDKViewType viewtype, bool& bDisabled) = 0;
204
211 virtual SDKError CanDisableViewerAnnotation(SDKViewType viewtype, bool& bCan) = 0;
212
219 virtual SDKError CanDoAnnotation(SDKViewType viewtype,bool& bCan) = 0;
220
226
231
236
237};
239#endif
Meeting annotation tool interface.
virtual SDKError Clear(SDKViewType viewtype, AnnotationClearType type)=0
Clear present annotations.
virtual SDKError SetColor(SDKViewType viewtype, unsigned long color)=0
Set the colors of annotation tools.
virtual SDKError SetLineWidth(SDKViewType viewtype, long lineWidth)=0
Set the line width of annotation tools.
virtual SDKError StartAnnotation(SDKViewType viewtype)=0
Display annotation toolbar.
virtual SDKError CanDisableViewerAnnotation(SDKViewType viewtype, bool &bCan)=0
Determine if it is able to disallow viewer to annotate.
virtual SDKError CanDoAnnotation(SDKViewType viewtype, bool &bCan)=0
Determine if it is able to annotate(Both the presenter and viewer can call the function).
virtual SDKError SetTool(SDKViewType viewtype, AnnotationToolType type)=0
Choose annotation tool.
virtual SDKError SetEvent(IMeetingAnnotationSupportEvent *pEvent)=0
Set the callback that annotation status changes.
virtual SDKError StopAnnotation(SDKViewType viewtype)=0
Close the current annotation toolbar.
virtual const zchar_t * getAnnotationLegalNoticesPrompt()=0
Get the annotation legal notices prompt.
virtual SDKError DisableViewerAnnotation(SDKViewType viewtype, bool bDisable)=0
Disallow/allow participants to annotate when viewing the sharing content.
virtual const zchar_t * getAnnotationLegalNoticesExplained()=0
the annotation legal notices explained.
virtual SDKError Redo(SDKViewType viewtype)=0
Redo the last-undo annotation.
virtual bool IsAnnotationDisable()=0
Determine whether current meeting supports annotation feature.
virtual bool IsAnnotationLegalNoticeAvailable()=0
Determine whether the legal notice for annotation is available.
virtual ICustomizedAnnotationController * GetCustomizedAnnotationController(ICustomizedShareRender *pShareRender=nullptr)=0
Get the controller of annotation tools used in user custom interface mode.
virtual SDKError Undo(SDKViewType viewtype)=0
Undo the last annotation.
virtual SDKError IsViewerAnnotationDisabled(SDKViewType viewtype, bool &bDisabled)=0
Determine if viewer's privilege of annotation is disabled.
Annotation controller interface.
Share render interface.
Callback interface that viewer's annotation status changes.
virtual void onSupportAnnotationStatus(unsigned int nShareSourceID, bool bSupportAnnotation)=0
The SDK will trigger this callback if the presenter enable/disable PARTICIPANTS ANNOTATION.
AnnotationToolType
Types of annotation tool. Here are more detailed structural descriptions.
@ ANNOTOOL_AUTO_RECTANGLE_FILL
@ ANNOTOOL_AUTO_ELLIPSE_SEMI_FILL
@ ANNOTOOL_AUTO_RECTANGLE_SEMI_FILL
AnnotationClearType
Clear types of annotation tools. Here are more detailed structural descriptions.
SDKViewType
SDK View Type, primary displayer and secondary displayer. Here are more detailed structural descripti...
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.