ZoomVideoSDKAnnotationHelper Class Reference

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

#include <ZoomVideoSDKAnnotationHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSenderDisableAnnotation
	Whether annotation was disabled or not by the share owner.
(BOOL)	- canDoAnnotation
	Whether the current user can do annotation on the share.
(ZoomVideoSDKError)	- startAnnotation
	Starts annotation.
(ZoomVideoSDKError)	- stopAnnotation
	Stops annotation.
(ZoomVideoSDKError)	- setToolColor:
	Set the annotation tool color.
(nullable UIColor *)	- getToolColor
	Gets the annotation tool color.
(ZoomVideoSDKError)	- setToolType:
	Set the annotation tool type.
(ZoomVideoSDKAnnotationToolType)	- getToolType
	Get the annotation tool type.
(ZoomVideoSDKError)	- setToolWidth:
	Set the annotation tool width.
(NSUInteger)	- getToolWidth
	Get 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

Whether the current user can do annotation on the share.

Returns

YES means the user can do annotation, otherwise can't.

clear:

- (ZoomVideoSDKError) clear:

(ZoomVideoSDKAnnotationClearType)

type

Clears the annotation content.

Parameters

type	the specify clear type.

Returns

The result of it.

getToolColor

- (nullable UIColor *) getToolColor

Gets the annotation tool color.

Returns

The current tool color.

getToolType

- (ZoomVideoSDKAnnotationToolType) getToolType

Get the annotation tool type.

Returns

The current tool type.

getToolWidth

- (NSUInteger) getToolWidth

Get the annotation tool width.

Returns

The current tool width.

isSenderDisableAnnotation

- (BOOL) isSenderDisableAnnotation

Whether annotation was disabled or not by the share owner.

Returns

The result of it.

Deprecated

Use canDoAnnotation instead.

redo

- (ZoomVideoSDKError) redo

Redoes one annotation content step.

Returns

The result of it.

setToolColor:

- (ZoomVideoSDKError) setToolColor:

(nullable UIColor *)

toolColor

Set the annotation tool color.

Parameters

toolColor

The specified color.

Returns

The result of it.

setToolType:

- (ZoomVideoSDKError) setToolType:

(ZoomVideoSDKAnnotationToolType)

type

Set the annotation tool type.

Parameters

type	the specify annotation tool type.

Returns

The result of it.

Warning

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

setToolWidth:

- (ZoomVideoSDKError) setToolWidth:

(NSUInteger)

width

Set the annotation tool width.

Parameters

width

The specified annotation tool width.

Returns

The result of it.

startAnnotation

- (ZoomVideoSDKError) startAnnotation

Starts annotation.

Returns

The result of it.

stopAnnotation

- (ZoomVideoSDKError) stopAnnotation

Stops annotation.

Returns

The result of it.

undo

- (ZoomVideoSDKError) undo

Undoes one annotation content step.

Returns

The result of it.