ZMVideoSDKAnnotationHelper Class Reference

Annotation helper interface for Zoom Video SDK. More...

#include <ZMVideoSDKAnnotationHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canDoAnnotation
	Whether the current user can do annotation on the share.
(BOOL)	- isSenderDisableAnnotation
	Whether annotation was disabled or not by the share owner.
(ZMVideoSDKErrors)	- startAnnotation
	Starts annotation.
(ZMVideoSDKErrors)	- stopAnnotation
	Stops annotation.
(ZMVideoSDKErrors)	- setToolColor:
	Sets the annotation tool color.
(ZMVideoSDKErrors)	- getToolColor:
	Gets the annotation tool color.
(ZMVideoSDKErrors)	- setToolType:
	Sets the annotation tool type.
(ZMVideoSDKErrors)	- getToolType:
	Gets the annotation tool type.
(ZMVideoSDKErrors)	- setToolWidth:
	Sets the annotation tool width.
(ZMVideoSDKErrors)	- getToolWidth:
	Gets the annotation tool width.
(ZMVideoSDKErrors)	- undo
	Undoes one annotation content step.
(ZMVideoSDKErrors)	- redo
	Redoes one annotation content step.
(ZMVideoSDKErrors)	- clear:
	Clears the annotation content.

Detailed Description

Annotation helper interface for Zoom Video SDK.

Definition at line 15 of file ZMVideoSDKAnnotationHelper.h.

Method Documentation

canDoAnnotation

- (BOOL) canDoAnnotation

Whether the current user can do annotation on the share.

Returns

YES if the user can do annotation. Otherwise, NO.

References canDoAnnotation.

Referenced by canDoAnnotation, and isSenderDisableAnnotation.

clear:

- (ZMVideoSDKErrors) clear:

(ZMVideoSDKAnnotationClearType)

type

Clears the annotation content.

Parameters

type	The specified clear type.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

getToolColor:

- (ZMVideoSDKErrors) getToolColor:

(NSColor *_Nullable *_Nonnull)

toolColor

Gets the annotation tool color.

Parameters

toolColor

The current tool color.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

getToolType:

- (ZMVideoSDKErrors) getToolType:

(ZMVideoSDKAnnotationToolType *)

toolType

Gets the annotation tool type.

Parameters

toolType

The current tool type.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

getToolWidth:

- (ZMVideoSDKErrors) getToolWidth:

(long *)

width

Gets the annotation tool width.

Parameters

width

The line width of annotations.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

isSenderDisableAnnotation

- (BOOL) isSenderDisableAnnotation

Whether annotation was disabled or not by the share owner.

Returns

YES if the annotations is disabled. Otherwise, NO.

Deprecated

Use ZMVideoSDKAnnotationHelper::canDoAnnotation instead.

References canDoAnnotation, and isSenderDisableAnnotation.

Referenced by isSenderDisableAnnotation.

redo

- (ZMVideoSDKErrors) redo

Redoes one annotation content step.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References redo.

Referenced by redo.

setToolColor:

- (ZMVideoSDKErrors) setToolColor:

(NSColor *_Nonnull)

toolColor

Sets the annotation tool color.

Parameters

toolColor

The specified color

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

setToolType:

- (ZMVideoSDKErrors) setToolType:

(ZMVideoSDKAnnotationToolType)

toolType

Sets the annotation tool type.

Parameters

toolType

The specified annotation tool type.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Warning

The tool type ZMVideoSDKAnnotationToolType_Picker and ZMVideoSDKAnnotationToolType_SpotLight are not support for viewer.

setToolWidth:

- (ZMVideoSDKErrors) setToolWidth:

(long)

width

Sets the annotation tool width.

Parameters

width

The specify annotation tool width.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

startAnnotation

- (ZMVideoSDKErrors) startAnnotation

Starts annotation.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References startAnnotation.

Referenced by startAnnotation.

stopAnnotation

- (ZMVideoSDKErrors) stopAnnotation

Stops annotation.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References stopAnnotation.

Referenced by stopAnnotation.

undo

- (ZMVideoSDKErrors) undo

Undoes one annotation content step.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References undo.

Referenced by undo.