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.

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

virtual SDKError	StartAnnotation (SDKViewType viewtype)=0
	Display annotation toolbar.

virtual SDKError	StopAnnotation (SDKViewType viewtype)=0
	Close the current annotation toolbar.

virtual SDKError	SetTool (SDKViewType viewtype, AnnotationToolType type)=0
	Choose annotation tool.

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	Undo (SDKViewType viewtype)=0
	Undo the last annotation.

virtual SDKError	Redo (SDKViewType viewtype)=0
	Redo the last-undo annotation.

virtual ICustomizedAnnotationController *	GetCustomizedAnnotationController (ICustomizedShareRender *pShareRender=nullptr)=0
	Get the controller of annotation tools used in user custom interface mode.

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

virtual SDKError	IsViewerAnnotationDisabled (SDKViewType viewtype, bool &bDisabled)=0
	Determine if viewer's privilege of annotation is disabled.

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 bool	IsAnnotationLegalNoticeAvailable ()=0
	Determine whether the legal notice for annotation is available.

virtual const zchar_t *	getAnnotationLegalNoticesPrompt ()=0
	Get the annotation legal notices prompt.

virtual const zchar_t *	getAnnotationLegalNoticesExplained ()=0
	the annotation legal notices explained.

Detailed Description

Meeting annotation tool interface.

Definition at line 101 of file meeting_annotation_interface.h.

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]	viewtype	SDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]	bCan	TRUE 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]	viewtype	SDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]	bCan	TRUE 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

viewtype	Specify on which view to clear the annotations. For more details, see SDKViewType enum.
type	Specify 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.

Note: 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]	viewtype	SDK_FIRST_VIEW/SDK_SECOND_VIEW
[in]	disable	TRUE 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.

◆ getAnnotationLegalNoticesExplained()

virtual const zchar_t * IAnnotationController::getAnnotationLegalNoticesExplained ( )

pure virtual

the annotation legal notices explained.

◆ getAnnotationLegalNoticesPrompt()

virtual const zchar_t * IAnnotationController::getAnnotationLegalNoticesPrompt ( )

pure virtual

Get the annotation legal notices prompt.

◆ GetCustomizedAnnotationController()

virtual ICustomizedAnnotationController * IAnnotationController::GetCustomizedAnnotationController ( ICustomizedShareRender * pShareRender = nullptr )

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 nullptr.

Note: Valid only for user custom interface mode.

◆ IsAnnotationDisable()

virtual bool IAnnotationController::IsAnnotationDisable ( )

pure virtual

Determine whether current meeting supports annotation feature.

Returns: true not support, false support.

◆ IsAnnotationLegalNoticeAvailable()

virtual bool IAnnotationController::IsAnnotationLegalNoticeAvailable ( )

pure virtual

Determine whether the legal notice for annotation is available.

Returns: True indicates the legal notice for annotation transcript is available. Otherwise False.

◆ IsViewerAnnotationDisabled()

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

pure virtual

Determine if viewer's privilege of annotation is disabled.

Parameters

[in]	viewtype	SDK_FIRST_VIEW/SDK_SECOND_VIEW
[out]	bDisabled	TRUE 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

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

Note: 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

viewtype	The specified color is used on which view. For more details, see SDKViewType enum.
color	Specify 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.

Note: 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

pEvent An 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

viewtype	The specified line width is used on which view. For more details, see SDKViewType enum.
lineWidth	Specify 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.

Note: Valid only for ZOOM style user interface mode.

◆ SetTool()

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

pure virtual

Choose annotation tool.

Parameters

viewtype	Specify which view to display the toolbar. For more details, see SDKViewType enum.
type	Specify 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.

Note: Valid only for ZOOM style user interface mode. The tool type ANNOTOOL_PICKER and ANNOTOOL_SPOTLIGHT are not support for viewer.

◆ StartAnnotation()

virtual SDKError IAnnotationController::StartAnnotation ( SDKViewType viewtype )

pure virtual

Display annotation toolbar.

Parameters

viewtype	Specify which view to display the toolbar. For more details, see SDKViewType enum.
left	Specify X-axis coordinate of the upper-left corner for the toolbar.
top	Specify 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.

Note: Valid only for ZOOM style user interface mode.

◆ StopAnnotation()

virtual SDKError IAnnotationController::StopAnnotation ( SDKViewType viewtype )

pure virtual

Close the current annotation toolbar.

Parameters

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

Note: Valid only for ZOOM style user interface mode.

◆ Undo()

virtual SDKError IAnnotationController::Undo ( SDKViewType viewtype )

pure virtual

Undo the last annotation.

Parameters

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

Note: Valid only for ZOOM style user interface mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanDisableViewerAnnotation()

◆ CanDoAnnotation()

◆ Clear()

◆ DisableViewerAnnotation()

◆ getAnnotationLegalNoticesExplained()

◆ getAnnotationLegalNoticesPrompt()

◆ GetCustomizedAnnotationController()

◆ IsAnnotationDisable()

◆ IsAnnotationLegalNoticeAvailable()

◆ IsViewerAnnotationDisabled()

◆ Redo()

◆ SetColor()

◆ SetEvent()

◆ SetLineWidth()

◆ SetTool()

◆ StartAnnotation()

◆ StopAnnotation()

◆ Undo()