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
45
56
59{
60public:
62 virtual void onSupportAnnotationStatus(unsigned int nShareSourceID, bool bSupportAnnotation) = 0;
63
65};
66
71{
72public:
78
81 virtual bool IsAnnotationDisable() = 0;
82
90 virtual SDKError StartAnnotation(SDKViewType viewtype) = 0;
91
97 virtual SDKError StopAnnotation(SDKViewType viewtype) = 0;
98
107 virtual SDKError SetTool(SDKViewType viewtype, AnnotationToolType type) = 0;
108
115 virtual SDKError Clear(SDKViewType viewtype, AnnotationClearType type) = 0;
116
117
124 virtual SDKError SetColor(SDKViewType viewtype, unsigned long color) = 0;
125
132 virtual SDKError SetLineWidth(SDKViewType viewtype, long lineWidth) = 0;
133
139 virtual SDKError Undo(SDKViewType viewtype) = 0;
140
146 virtual SDKError Redo(SDKViewType viewtype) = 0;
147
153
159 virtual SDKError DisableViewerAnnotation(SDKViewType viewtype, bool bDisable) = 0;
160
166 virtual SDKError IsViewerAnnotationDisabled(SDKViewType viewtype, bool& bDisabled) = 0;
167
173 virtual SDKError CanDisableViewerAnnotation(SDKViewType viewtype, bool& bCan) = 0;
174
180 virtual SDKError CanDoAnnotation(SDKViewType viewtype,bool& bCan) = 0;
181
185
188
191
192};
194#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
Get 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_NONE_DRAWING
Switch to mouse cursor.
@ ANNOTOOL_AUTO_ELLIPSE_FILL
A filled ellipse.
@ ANNOTOOL_AUTO_STAMP_X
A sign marking that something is wrong.
@ ANNOTOOL_AUTO_LINE
A straight line changes automatically in pace with the mouse cursor.
@ ANNOTOOL_AUTO_ARROW
An arrow changes automatically in pace with the mouse cursor.
@ ANNOTOOL_AUTO_RECTANGLE_FILL
A filled rectangle.
@ ANNOTOOL_AUTO_STAMP_ARROW
A fixed-size arrow for marking.
@ ANNOTOOL_AUTO_DOUBLE_ARROW
A line with double-arrow.
@ ANNOTOOL_AUTO_ELLIPSE
An ellipse changes automatically in pace with the mouse cursor.
@ ANNOTOOL_AUTO_DIAMOND
An unfilled rhombus.
@ ANNOTOOL_AUTO_STAMP_STAR
A star for marking.
@ ANNOTOOL_PICKER
Select the annotations.
@ ANNOTOOL_SPOTLIGHT
Laser pointer.
@ ANNOTOOL_HIGHLIGHTER
Highlighter.
@ ANNOTOOL_ARROW
An arrow showing the name of whom click on the sharing content.
@ ANNOTOOL_TEXTBOX
Insert a textbox in order to input letters.
@ ANNOTOOL_ERASER
An eraser.
@ ANNOTOOL_AUTO_STAMP_QM
A sign for interrogation.
@ ANNOTOOL_AUTO_STAMP_CHECK
A sign marking that something is correct.
@ ANNOTOOL_AUTO_STAMP_HEART
A heart for marking.
@ ANNOTOOL_AUTO_ELLIPSE_SEMI_FILL
A fair ellipse changes automatically in pace with the mouse cursor.
@ ANNOTOOL_AUTO_RECTANGLE
A rectangle changes automatically in pace with the mouse cursor.
@ ANNOTOOL_AUTO_RECTANGLE_SEMI_FILL
A fair rectangle changes automatically in pace with the mouse cursor.
AnnotationClearType
Clear types of annotation tools. Here are more detailed structural descriptions.
@ ANNOCLEAR_ALL
Clear all annotations. Hosts, managers and shared meeting owners can use.
@ ANNOCLEAR_SELF
Clear only your own annotations. Everyone can use.
@ ANNOCLEAR_OTHER
Clear only the others' annotations. Only shared meeting owners can use.
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
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.