IZoomVideoSDKAnnotationHelper Class Reference

Annotation helper interface. More...

#include <zoom_video_sdk_annotation_helper_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKAnnotationHelper ()
virtual bool	canDoAnnotation ()=0
	Determines Whether the current user can do annotation on the share.
virtual bool	isSenderDisableAnnotation ()=0
	Determines whether annotation was disabled or not by the share owner.
virtual ZoomVideoSDKErrors	startAnnotation ()=0
	Starts annotation.
virtual ZoomVideoSDKErrors	stopAnnotation ()=0
	Stops annotation.
virtual ZoomVideoSDKErrors	setToolType (ZoomVideoSDKAnnotationToolType toolType)=0
	Sets the annotation tool type.
virtual ZoomVideoSDKErrors	getToolType (ZoomVideoSDKAnnotationToolType &toolType)=0
	Gets the annotation tool type.
virtual ZoomVideoSDKErrors	setToolColor (unsigned long color)=0
	Sets the annotation tool color.
virtual ZoomVideoSDKErrors	getToolColor (unsigned long &color)=0
	Gets the annotation tool color.
virtual ZoomVideoSDKErrors	setToolWidth (long lineWidth)=0
	Sets the annotation tool width.
virtual ZoomVideoSDKErrors	getToolWidth (long &lineWidth)=0
	Gets the annotation tool width.
virtual ZoomVideoSDKErrors	clear (ZoomVideoSDKAnnotationClearType clearType)=0
	ClearS the annotation content.
virtual ZoomVideoSDKErrors	undo ()=0
	Undo one annotation content step.
virtual ZoomVideoSDKErrors	redo ()=0
	Redo one annotation content step.

Detailed Description

Annotation helper interface.

Definition at line 69 of file zoom_video_sdk_annotation_helper_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKAnnotationHelper()

virtual IZoomVideoSDKAnnotationHelper::~IZoomVideoSDKAnnotationHelper ( )

inlinevirtual

Definition at line 72 of file zoom_video_sdk_annotation_helper_interface.h.

{};

Member Function Documentation

canDoAnnotation()

virtual bool IZoomVideoSDKAnnotationHelper::canDoAnnotation ( )

pure virtual

Determines Whether the current user can do annotation on the share.

Returns

true if the user can do annotation. Otherwise, false.

clear()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::clear ( ZoomVideoSDKAnnotationClearType clearType )

pure virtual

ClearS the annotation content.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

Host and manager can clear all and clear self; Share owner can clear all, clear othersand clear self; Attendee can only clear self.

getToolColor()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::getToolColor ( unsigned long & color )

pure virtual

Gets the annotation tool color.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

getToolType()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::getToolType ( ZoomVideoSDKAnnotationToolType & toolType )

pure virtual

Gets the annotation tool type.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

getToolWidth()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::getToolWidth ( long & lineWidth )

pure virtual

Gets the annotation tool width.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

isSenderDisableAnnotation()

virtual bool IZoomVideoSDKAnnotationHelper::isSenderDisableAnnotation ( )

pure virtual

Determines whether annotation was disabled or not by the share owner.

Returns

true disable, false not disable.

Deprecated

Use canDoAnnotation instead.

redo()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::redo ( )

pure virtual

Redo one annotation content step.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setToolColor()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::setToolColor ( unsigned long color )

pure virtual

Sets the annotation tool color.

Parameters

color

The specified color.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setToolType()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::setToolType ( ZoomVideoSDKAnnotationToolType toolType )

pure virtual

Sets the annotation tool type.

Parameters

toolType

The specified tool type.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

The tool type ZoomVideoSDKAnnotationToolType_Picker and ZoomVideoSDKAnnotationToolType_SpotLight are not support for viewer.

setToolWidth()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::setToolWidth ( long lineWidth )

pure virtual

Sets the annotation tool width.

Parameters

lineWidth

The specified tool width.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

startAnnotation()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::startAnnotation ( )

pure virtual

Starts annotation.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

stopAnnotation()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::stopAnnotation ( )

pure virtual

Stops annotation.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

undo()

virtual ZoomVideoSDKErrors IZoomVideoSDKAnnotationHelper::undo ( )

pure virtual

Undo one annotation content step.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.