MobileRTCAnnotationService Class Reference

The Zoom annotation service for managing annotation. More...

#include <MobileRTCAnnotationService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canDoAnnotation:
	Check if the current shareView can do annotation or not.
(MobileRTCAnnotationError)	- startAnnotationWithSharedView:
	Set to start annotations on the shared view.
(BOOL)	- stopAnnotation
	Set to stop annotations.
(MobileRTCAnnotationError)	- setToolColor:
	Set the colors of annotation tools.
(nullable UIColor *)	- getToolColor
	This method is used to get current Anno Tool Color.
(MobileRTCAnnotationError)	- setToolType:
	Set the types of annotation tools.
(MobileRTCAnnoTool)	- getToolType
	Get the annotation tool type.
(MobileRTCAnnotationError)	- setToolWidth:
	Set the line width of annotation tools.
(NSUInteger)	- getToolWidth
	Get the annotation tool width.
(MobileRTCAnnotationError)	- clear:
	Clears the annotation content.
(MobileRTCAnnotationError)	- undo
	Undo the last annotation.
(MobileRTCAnnotationError)	- redo
	Redo the last annotation.
(BOOL)	- isPresenter
	Check if the current user is the presenter.
(BOOL)	- canDisableViewerAnnotation
	Check if support to disable viewer's annotation item.
(BOOL)	- isViewerAnnotationDisabled
	Check currently sender disabled the viewer's annotation or not.
(MobileRTCAnnotationError)	- disableViewerAnnotation:
	Disable viewer's annotation.
(BOOL)	- isAnnotationLegalNoticeAvailable
	Is annotation legal notice available.
(NSString *_Nullable)	- getAnnotationLegalNoticesPrompt
	Get annotation over share legal notices prompt.
(NSString *_Nullable)	- getAnnotationLegalNoticesExplained
	Get annotation over share legal notices explained.

Properties
id< MobileRTCAnnotationServiceDelegate > _Nullable	delegate
	Callback of receiving meeting events.

Detailed Description

The Zoom annotation service for managing annotation.

Definition at line 102 of file MobileRTCAnnotationService.h.

Method Documentation

canDisableViewerAnnotation

- (BOOL) canDisableViewerAnnotation

Check if support to disable viewer's annotation item.

Returns

Yes if support.

References canDisableViewerAnnotation, delegate, getAnnotationLegalNoticesExplained, getAnnotationLegalNoticesPrompt, getToolColor, getToolType, getToolWidth, isAnnotationLegalNoticeAvailable, isPresenter, isViewerAnnotationDisabled, redo, stopAnnotation, and undo.

Referenced by canDisableViewerAnnotation.

canDoAnnotation:

- (BOOL) canDoAnnotation:

(nullable UIView *)

shareView

Check if the current shareView can do annotation or not.

Parameters

shareView

The shared view.

Returns

Yes if can do the annotation.

Warning

In ZoomUI Mode, If shareView is nil ,That means the currently active Zoom Subscribe Share View.

clear:

- (MobileRTCAnnotationError) clear:

(MobileRTCAnnoClearType)

type

Clears the annotation content.

Parameters

type	the specify clear type.

Returns

The result of it.

disableViewerAnnotation:

- (MobileRTCAnnotationError) disableViewerAnnotation:

(BOOL)

isDisable

Disable viewer's annotation.

Returns

MobileRTCAnnotationError_Successed if disabled the viewer's annotation success.

getAnnotationLegalNoticesExplained

- (NSString *_Nullable) getAnnotationLegalNoticesExplained

Get annotation over share legal notices explained.

Returns

Annotation over share legal notices explained.

Referenced by canDisableViewerAnnotation.

getAnnotationLegalNoticesPrompt

- (NSString *_Nullable) getAnnotationLegalNoticesPrompt

Get annotation over share legal notices prompt.

Returns

Annotation over share legal notices prompt.

Referenced by canDisableViewerAnnotation.

getToolColor

- (nullable UIColor *) getToolColor

This method is used to get current Anno Tool Color.

Returns

Get color by tool type.

Referenced by canDisableViewerAnnotation.

getToolType

- (MobileRTCAnnoTool) getToolType

Get the annotation tool type.

Returns

The current tool type.

Referenced by canDisableViewerAnnotation.

getToolWidth

- (NSUInteger) getToolWidth

Get the annotation tool width.

Returns

The current tool width.

Referenced by canDisableViewerAnnotation.

isAnnotationLegalNoticeAvailable

- (BOOL) isAnnotationLegalNoticeAvailable

Is annotation legal notice available.

Returns

Available or not.

Referenced by canDisableViewerAnnotation.

isPresenter

- (BOOL) isPresenter

Check if the current user is the presenter.

Returns

Yes if be presenter.

Warning

That need to start annotation first.

Referenced by canDisableViewerAnnotation.

isViewerAnnotationDisabled

- (BOOL) isViewerAnnotationDisabled

Check currently sender disabled the viewer's annotation or not.

Returns

Yes if disabled viewer's annotation.

Referenced by canDisableViewerAnnotation.

redo

- (MobileRTCAnnotationError) redo

Redo the last annotation.

Returns

The result of redoing the annotations.

Referenced by canDisableViewerAnnotation.

setToolColor:

- (MobileRTCAnnotationError) setToolColor:

(nullable UIColor *)

toolColor

Set the colors of annotation tools.

Returns

The result of setting the colors.

setToolType:

- (MobileRTCAnnotationError) setToolType:

(MobileRTCAnnoTool)

type

Set the types of annotation tools.

Returns

The result of operation.

Warning

The tool type MobileRTCAnnoTool_Picker and MobileRTCAnnoTool_SpotLight are not support for viewer.

setToolWidth:

- (MobileRTCAnnotationError) setToolWidth:

(NSUInteger)

width

Set the line width of annotation tools.

Returns

The result of operation.

startAnnotationWithSharedView:

- (MobileRTCAnnotationError) startAnnotationWithSharedView:

(nullable UIView *)

shareView

Set to start annotations on the shared view.

Parameters

shareView

The shared view.

Returns

The result of operation.

stopAnnotation

- (BOOL) stopAnnotation

Set to stop annotations.

Returns

The result of operation.

Referenced by canDisableViewerAnnotation.

undo

- (MobileRTCAnnotationError) undo

Undo the last annotation.

Returns

The result of undoing the annotations.

Referenced by canDisableViewerAnnotation.

Property Documentation

delegate

- (id<MobileRTCAnnotationServiceDelegate> _Nullable) delegate

readwritenonatomicweak

Callback of receiving meeting events.

Definition at line 107 of file MobileRTCAnnotationService.h.

Referenced by canDisableViewerAnnotation.