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

Annotation object interface. More...

#include <customized_annotation.h>

Public Member Functions

virtual SDKError SetEvent (ICustomizedAnnotationObjEvent *event_)=0
 Set annotation object callback event handler. More...
 
virtual SDKError CanClear (AnnotationClearType type)=0
 Determine if it is enabled to clear annotations by the specified way. More...
 
virtual SDKError Clear (AnnotationClearType type)=0
 Clear the annotation with the specified type. More...
 
virtual SDKError SetTool (AnnotationToolType type)=0
 Set the tool to annotate. More...
 
virtual SDKError SetColor (unsigned long color)=0
 Set the color to annotate. More...
 
virtual SDKError SetLineWidth (long lineWidth)=0
 Set the value of line width of annotation tool. More...
 
virtual SDKError GetCurColor (unsigned long &color)=0
 Get the color of current annotation tool. More...
 
virtual SDKError GetCurLineWidth (long &lineWidth)=0
 Get the value of line width of the current annotation tool. More...
 
virtual SDKError GetCurTool (AnnotationToolType &type)=0
 Get the type of the current annotation tool. More...
 
virtual SDKError Undo ()=0
 Undo the last annotation. More...
 
virtual SDKError Redo ()=0
 Redo the annotation that was undone. More...
 
virtual SDKError CanSaveSnapshot ()=0
 Determine if it is enabled to save the screenshot. More...
 
virtual SDKError SaveSnapshot (const wchar_t *path, SDKAnnoSaveType nType)=0
 Save the screenshot in the specified path. More...
 
virtual SDKError CanDoAnnotation (bool &bCan)=0
 Determine if can do annotate. More...
 
virtual bool IsAnnoataionDisable ()=0
 Determine whether annotations are currently available. More...
 

Detailed Description

Annotation object interface.

Member Function Documentation

◆ CanClear()

virtual SDKError ICustomizedAnnotationObj::CanClear ( AnnotationClearType  type)
pure virtual

Determine if it is enabled to clear annotations by the specified way.

Parameters
typeSpecify the annotation clear type. For more details, see AnnotationClearType enum.
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 ICustomizedAnnotationObj::CanDoAnnotation ( bool &  bCan)
pure virtual

Determine if can do annotate.

Parameters
[out]bCan,truemeans can do annotate, false can not.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CanSaveSnapshot()

virtual SDKError ICustomizedAnnotationObj::CanSaveSnapshot ( )
pure virtual

Determine if it is enabled to save the screenshot.

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 ICustomizedAnnotationObj::Clear ( AnnotationClearType  type)
pure virtual

Clear the annotation with the specified type.

Parameters
typeSpecify the type to clear annotation. For more details, see AnnotationClearType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCurColor()

virtual SDKError ICustomizedAnnotationObj::GetCurColor ( unsigned long &  color)
pure virtual

Get the color of current annotation tool.

Parameters
[out]colorThe color to annotate in RGB format.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCurLineWidth()

virtual SDKError ICustomizedAnnotationObj::GetCurLineWidth ( long &  lineWidth)
pure virtual

Get the value of line width of the current annotation tool.

Parameters
[out]lineWidthThe width of the current annotation tool.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCurTool()

virtual SDKError ICustomizedAnnotationObj::GetCurTool ( AnnotationToolType type)
pure virtual

Get the type of the current annotation tool.

Parameters
typeSpecify the type of the annotation tool. For more details, see AnnotationToolType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ IsAnnoataionDisable()

virtual bool ICustomizedAnnotationObj::IsAnnoataionDisable ( )
pure virtual

Determine whether annotations are currently available.

Returns
true available, false invalid.

◆ Redo()

virtual SDKError ICustomizedAnnotationObj::Redo ( )
pure virtual

Redo the annotation that was undone.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SaveSnapshot()

virtual SDKError ICustomizedAnnotationObj::SaveSnapshot ( const wchar_t *  path,
SDKAnnoSaveType  nType 
)
pure virtual

Save the screenshot in the specified path.

Parameters
pathSpecify the path to store the screenshot. If the specified path is wrong, the SDKERR_INVALID_PARAMETER will be returned.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetColor()

virtual SDKError ICustomizedAnnotationObj::SetColor ( unsigned long  color)
pure virtual

Set the color to annotate.

Parameters
colorSpecify the color to annotate, in RGB format.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError ICustomizedAnnotationObj::SetEvent ( ICustomizedAnnotationObjEvent event_)
pure virtual

Set annotation object callback event handler.

Parameters
event_A pointer to the ICustomizedAnnotationObjEvent that receives annotation object event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetLineWidth()

virtual SDKError ICustomizedAnnotationObj::SetLineWidth ( long  lineWidth)
pure virtual

Set the value of line width of annotation tool.

Parameters
lineWidthThe line width of annotation tool.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetTool()

virtual SDKError ICustomizedAnnotationObj::SetTool ( AnnotationToolType  type)
pure virtual

Set the tool to annotate.

Parameters
typeSpecify the type of the annotation tool. For more details, see AnnotationToolType enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ Undo()

virtual SDKError ICustomizedAnnotationObj::Undo ( )
pure virtual

Undo the last annotation.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

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