Annotation object interface. More...

#include <customized_annotation.h>

Public Member Functions
virtual SDKError	SetEvent (ICustomizedAnnotationObjEvent *event_)=0
	Set annotation object callback event handler.

virtual SDKError	CanClear (AnnotationClearType type)=0
	Determine if it is enabled to clear annotations by the specified way.

virtual SDKError	Clear (AnnotationClearType type)=0
	Clear the annotation with the specified type.

virtual SDKError	SetTool (AnnotationToolType type)=0
	Set the tool to annotate.

virtual SDKError	SetColor (unsigned long color)=0
	Set the color to annotate.

virtual SDKError	SetLineWidth (long lineWidth)=0
	Set the value of line width of annotation tool.

virtual SDKError	GetCurColor (unsigned long &color)=0
	Get the color of current annotation tool.

virtual SDKError	GetCurLineWidth (long &lineWidth)=0
	Get the value of line width of the current annotation tool.

virtual SDKError	GetCurTool (AnnotationToolType &type)=0
	Get the type of the current annotation tool.

virtual SDKError	Undo ()=0
	Undo the last annotation.

virtual SDKError	Redo ()=0
	Redo the annotation that was undone.

virtual SDKError	CanSaveSnapshot ()=0
	Determine if it is enabled to save the screenshot.

virtual SDKError	SaveSnapshot (const zchar_t *path, SDKAnnoSaveType nType)=0
	Save the screenshot in the specified path.

virtual SDKError	CanDoAnnotation (bool &bCan)=0
	Determine if can do annotate.

virtual bool	IsAnnotationDisable ()=0
	Determine whether current meeting supports annotation feature.

virtual SDKError	DisableViewerAnnotation (bool bDisable)=0
	Disallow/allow participants to annotate when viewing the sharing content.

virtual SDKError	CanDisableViewerAnnotation (bool &bCan)=0
	Determine if it is able to disallow viewer to annotate.

virtual bool	IsViewerAnnotationDisabled ()=0
	Determine if viewer's privilege of annotation is disabled.

virtual	~ICustomizedAnnotationObj ()

Detailed Description

Annotation object interface.

Definition at line 45 of file customized_annotation.h.

Constructor & Destructor Documentation

◆ ~ICustomizedAnnotationObj()

virtual ICustomizedAnnotationObj::~ICustomizedAnnotationObj ( )

inlinevirtual

Definition at line 149 of file customized_annotation.h.

149{};

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

type	Specify 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.

◆ CanDisableViewerAnnotation()

virtual SDKError ICustomizedAnnotationObj::CanDisableViewerAnnotation ( bool & bCan )

pure virtual

Determine if it is able to disallow viewer to annotate.

Parameters

[out] bCan TRUE means able, FALSE not. It validates only when the return value is SDKErr_Success.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. 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,true means 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

type	Specify 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.

◆ DisableViewerAnnotation()

virtual SDKError ICustomizedAnnotationObj::DisableViewerAnnotation ( bool bDisable )

pure virtual

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

Parameters

bDisable TRUE means disabled, FALSE not.

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] color 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.

◆ GetCurLineWidth()

virtual SDKError ICustomizedAnnotationObj::GetCurLineWidth ( long & lineWidth )

pure virtual

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

Parameters

[out] lineWidth The 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

type	Specify 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.

◆ IsAnnotationDisable()

virtual bool ICustomizedAnnotationObj::IsAnnotationDisable ( )

pure virtual

Determine whether current meeting supports annotation feature.

Returns: true not support, false support.

◆ IsViewerAnnotationDisabled()

virtual bool ICustomizedAnnotationObj::IsViewerAnnotationDisabled ( )

pure virtual

Determine if viewer's privilege of annotation is disabled.

Returns: True indicates viewer's privilege of annotation is disabled. Otherwise False.

◆ 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 zchar_t *	path,
		SDKAnnoSaveType	nType )

pure virtual

Save the screenshot in the specified path.

Parameters

path	Specify 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

color Specify 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

lineWidth The 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

type	Specify 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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ICustomizedAnnotationObj()

Member Function Documentation

◆ CanClear()

◆ CanDisableViewerAnnotation()

◆ CanDoAnnotation()

◆ CanSaveSnapshot()

◆ Clear()

◆ DisableViewerAnnotation()

◆ GetCurColor()

◆ GetCurLineWidth()

◆ GetCurTool()

◆ IsAnnotationDisable()

◆ IsViewerAnnotationDisabled()

◆ Redo()

◆ SaveSnapshot()

◆ SetColor()

◆ SetEvent()

◆ SetLineWidth()

◆ SetTool()

◆ Undo()