ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IAnnotationController Class Referenceabstract

Meeting annotation tool interface. More...

#include <meeting_annotation_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingAnnotationSupportEvent *pEvent)=0
 Set the callback that annotation status changes. More...
 
virtual bool IsAnnoataionDisable (SDKViewType viewtype=SDK_FIRST_VIEW)=0
 Determine if the annotation tools are disabled or not for the specified view during the current meeting. More...
 
virtual SDKError StartAnnotation (SDKViewType viewtype, int left, int top)=0
 Display annotation toolbar. More...
 
virtual SDKError StopAnnotation (SDKViewType viewtype)=0
 Close the current annotation toolbar. More...
 
virtual SDKError SetTool (SDKViewType viewtype, AnnotationToolType type)=0
 Choose annotation tool. More...
 
virtual SDKError Clear (SDKViewType viewtype, AnnotationClearType type)=0
 Clear present annotations. More...
 
virtual SDKError SetColor (SDKViewType viewtype, unsigned long color)=0
 Set the colors of annotation tools. More...
 
virtual SDKError SetLineWidth (SDKViewType viewtype, long lineWidth)=0
 Set the line width of annotation tools. More...
 
virtual SDKError Undo (SDKViewType viewtype)=0
 Undo the last annotation. More...
 
virtual SDKError Redo (SDKViewType viewtype)=0
 Redo the last-undo annotation. More...
 
virtual ICustomizedAnnotationControllerGetCustomizedAnnotationController (ICustomizedShareRender *pShareRender=NULL)=0
 Get the controller of annotation tools used in user custom interface mode. More...
 
virtual SDKError DisableViewerAnnotation (SDKViewType viewtype, bool bDisable)=0
 Disallow/allow participants to annotate when viewing the sharing content. More...
 
virtual SDKError IsViewerAnnotationDisabled (SDKViewType viewtype, bool &bDisabled)=0
 Determine if viewer's privilege of annotation is disabled. More...
 
virtual SDKError CanDisableViewerAnnotation (SDKViewType viewtype, bool &bCan)=0
 Determine if it is able to disallow viewer to annotate. More...
 
virtual SDKError CanDoAnnotation (SDKViewType viewtype, bool &bCan)=0
 Determine if it is able to annotate(Both the presenter and viewer can call the function). More...
 

Detailed Description

Meeting annotation tool interface.

Member Function Documentation

◆ CanDisableViewerAnnotation()

virtual SDKError IAnnotationController::CanDisableViewerAnnotation ( SDKViewType  viewtype,
bool &  bCan 
)
pure virtual

Determine if it is able to disallow viewer to annotate.

Parameters
[in]viewtypeSDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]bCanTRUE means able, FALSE not. It validates only when the return value is SDKErr_Success.
Returns
If the user owns the authority, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

◆ CanDoAnnotation()

virtual SDKError IAnnotationController::CanDoAnnotation ( SDKViewType  viewtype,
bool &  bCan 
)
pure virtual

Determine if it is able to annotate(Both the presenter and viewer can call the function).

Parameters
[in]viewtypeSDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]bCanTRUE means able, FALSE not. It validates only when the return value is SDKErr_Success.
Returns
If the user owns the authority, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

◆ Clear()

virtual SDKError IAnnotationController::Clear ( SDKViewType  viewtype,
AnnotationClearType  type 
)
pure virtual

Clear present annotations.

Parameters
viewtypeSpecify on which view to clear the annotations. For more details, see SDKViewType enum.
typeSpecify the ways to clear annotations. For the definitions of the tools, see AnnotationClearType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ DisableViewerAnnotation()

virtual SDKError IAnnotationController::DisableViewerAnnotation ( SDKViewType  viewtype,
bool  bDisable 
)
pure virtual

Disallow/allow participants to annotate when viewing the sharing content.

Parameters
[in]viewtypeSDK_FIRST_VIEW/SDK_SECOND_VIEW
[in]disableTRUE means disabled, FALSE not.
Returns
If the user owns the authority, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

◆ GetCustomizedAnnotationController()

virtual ICustomizedAnnotationController* IAnnotationController::GetCustomizedAnnotationController ( ICustomizedShareRender pShareRender = NULL)
pure virtual

Get the controller of annotation tools used in user custom interface mode.

Returns
If the function succeeds, the return value is the controller of annotation tools used in user custom interface mode. If the function fails, the return value is NULL.
Remarks
Valid only for user custom interface mode.

◆ IsAnnoataionDisable()

virtual bool IAnnotationController::IsAnnoataionDisable ( SDKViewType  viewtype = SDK_FIRST_VIEW)
pure virtual

Determine if the annotation tools are disabled or not for the specified view during the current meeting.

Parameters
viewtypeSpecify which view to be determined. For more details, see SDKViewType enum.
Returns
FALSE indicates enabled while TRUE indicates disabled.
Remarks
Valid for both ZOOM style and user custom interface mode.

◆ IsViewerAnnotationDisabled()

virtual SDKError IAnnotationController::IsViewerAnnotationDisabled ( SDKViewType  viewtype,
bool &  bDisabled 
)
pure virtual

Determine if viewer's privilege of annotation is disabled.

Parameters
[in]viewtypeSDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]bDisabledTRUE means disabled, FALSE not. It validates only when the return value is SDKErr_Success.
Returns
If the user owns the authority, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

◆ Redo()

virtual SDKError IAnnotationController::Redo ( SDKViewType  viewtype)
pure virtual

Redo the last-undo annotation.

Parameters
viewtypeSpecify on which view to redo the last-undo annotation. For more details, see SDKViewType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ SetColor()

virtual SDKError IAnnotationController::SetColor ( SDKViewType  viewtype,
unsigned long  color 
)
pure virtual

Set the colors of annotation tools.

Parameters
viewtypeThe specified color is used on which view. For more details, see SDKViewType enum.
colorSpecify the color of the annotation tools in RGB format.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ SetEvent()

virtual SDKError IAnnotationController::SetEvent ( IMeetingAnnotationSupportEvent pEvent)
pure virtual

Set the callback that annotation status changes.

Parameters
pEventAn object pointer to the the IMeetingAnnotationSupportEvent that receives the annotation status changing callback event.
Returns
If the user owns the authority, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

◆ SetLineWidth()

virtual SDKError IAnnotationController::SetLineWidth ( SDKViewType  viewtype,
long  lineWidth 
)
pure virtual

Set the line width of annotation tools.

Parameters
viewtypeThe specified line width is used on which view. For more details, see SDKViewType enum.
lineWidthSpecify the line width to annotate.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ SetTool()

virtual SDKError IAnnotationController::SetTool ( SDKViewType  viewtype,
AnnotationToolType  type 
)
pure virtual

Choose annotation tool.

Parameters
viewtypeSpecify which view to display the toolbar. For more details, see SDKViewType enum.
typeSpecify the annotation tool to be used. For the definitions of the tools, see AnnotationToolType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ StartAnnotation()

virtual SDKError IAnnotationController::StartAnnotation ( SDKViewType  viewtype,
int  left,
int  top 
)
pure virtual

Display annotation toolbar.

Parameters
viewtypeSpecify which view to display the toolbar. For more details, see SDKViewType enum.
leftSpecify X-axis coordinate of the upper-left corner for the toolbar.
topSpecify Y-axis coordinate of the upper-left corner for the toolbar.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. For extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ StopAnnotation()

virtual SDKError IAnnotationController::StopAnnotation ( SDKViewType  viewtype)
pure virtual

Close the current annotation toolbar.

Parameters
viewtypeSpecify which view to close the toolbar. For more details, see SDKViewType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. For extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

◆ Undo()

virtual SDKError IAnnotationController::Undo ( SDKViewType  viewtype)
pure virtual

Undo the last annotation.

Parameters
viewtypeSpecify on which view to undo the last annotation. For more details, see SDKViewType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for ZOOM style user interface mode.

The documentation for this class was generated from the following file: