ZoomVideoSDKAnnotationHelper Class Reference

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

#include <ZoomVideoSDKAnnotationHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSenderDisableAnnotation
	Determines whether annotation was disabled by the share owner.
(BOOL)	- canDoAnnotation
	Determines whether the current user can do annotation on the share.
(ZoomVideoSDKError)	- startAnnotation
	Starts annotation.
(ZoomVideoSDKError)	- stopAnnotation
	Stops annotation.
(ZoomVideoSDKError)	- setToolColor:
	Sets the annotation tool color.
(nullable UIColor *)	- getToolColor
	Gets the annotation tool color.
(ZoomVideoSDKError)	- setToolType:
	Sets the annotation tool type.
(ZoomVideoSDKAnnotationToolType)	- getToolType
	Gets the annotation tool type.
(ZoomVideoSDKError)	- setToolWidth:
	Sets the annotation tool width.
(NSUInteger)	- getToolWidth
	Gets the annotation tool width.
(ZoomVideoSDKError)	- undo
	Undoes one annotation content step.
(ZoomVideoSDKError)	- redo
	Redoes one annotation content step.
(ZoomVideoSDKError)	- clear:
	Clears the annotation content.

Detailed Description

Annotation helper interface for Zoom Video SDK.

Definition at line 13 of file ZoomVideoSDKAnnotationHelper.h.

Method Documentation

canDoAnnotation

- (BOOL) canDoAnnotation

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

- (ZoomVideoSDKError) clear:

(ZoomVideoSDKAnnotationClearType)

type

Clears the annotation content.

Parameters

type	The specified clear type.

Returns

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

getToolColor

- (nullable UIColor *) getToolColor

Gets the annotation tool color.

Returns

If the function succeeds, it returns the current tool color. Otherwise, this function fails and returns nil.

References getToolColor.

Referenced by getToolColor.

getToolType

- (ZoomVideoSDKAnnotationToolType) getToolType

Gets the annotation tool type.

Returns

The current tool type.

References getToolType.

Referenced by getToolType.

getToolWidth

- (NSUInteger) getToolWidth

Gets the annotation tool width.

Returns

The current tool width.

References getToolWidth.

Referenced by getToolWidth.

isSenderDisableAnnotation

- (BOOL) isSenderDisableAnnotation

Determines whether annotation was disabled by the share owner.

Returns

YES if annotation was disabled by the share owner. Otherwise, NO.

Deprecated

Use canDoAnnotation instead.

References canDoAnnotation, and isSenderDisableAnnotation.

Referenced by isSenderDisableAnnotation.

redo

- (ZoomVideoSDKError) redo

Redoes one annotation content step.

Returns

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

References redo.

Referenced by redo.

setToolColor:

- (ZoomVideoSDKError) setToolColor:

(nullable UIColor *)

toolColor

Sets the annotation tool color.

Parameters

toolColor

The specified color.

Returns

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

setToolType:

- (ZoomVideoSDKError) setToolType:

(ZoomVideoSDKAnnotationToolType)

type

Sets the annotation tool type.

Parameters

type	The specified annotation tool type.

Returns

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

Warning

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

setToolWidth:

- (ZoomVideoSDKError) setToolWidth:

(NSUInteger)

width

Sets the annotation tool width.

Parameters

width

The specified annotation tool width.

Returns

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

startAnnotation

- (ZoomVideoSDKError) startAnnotation

Starts annotation.

Returns

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

References startAnnotation.

Referenced by startAnnotation.

stopAnnotation

- (ZoomVideoSDKError) stopAnnotation

Stops annotation.

Returns

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

References stopAnnotation.

Referenced by stopAnnotation.

undo

- (ZoomVideoSDKError) undo

Undoes one annotation content step.

Returns

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

References undo.

Referenced by undo.