MobileRTCAnnotationService Class Reference

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

#include <MobileRTCAnnotationService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canDoAnnotation:
	Determines if the current shareView can do annotation or not.
(MobileRTCAnnotationError)	- startAnnotationWithSharedView:
	Starts annotations on the shared view.
(BOOL)	- stopAnnotation
	Stops annotations.
(MobileRTCAnnotationError)	- setToolColor:
	Sets the colors of annotation tools.
(nullable UIColor *)	- getToolColor
	Gets the current annotation tool color.
(MobileRTCAnnotationError)	- setToolType:
	Sets the types of annotation tools.
(MobileRTCAnnoTool)	- getToolType
	Gets the annotation tool type.
(MobileRTCAnnotationError)	- setToolWidth:
	Sets the line width of annotation tools.
(NSUInteger)	- getToolWidth
	Gets the annotation tool width.
(MobileRTCAnnotationError)	- clear:
	Clears the annotation content.
(MobileRTCAnnotationError)	- undo
	Undo the last annotation.
(MobileRTCAnnotationError)	- redo
	Redo the last annotation.
(BOOL)	- isPresenter
	Determines if the current user is the presenter.
(BOOL)	- canDisableViewerAnnotation
	Determines if it supports disabling viewer's annotation item.
(BOOL)	- isViewerAnnotationDisabled
	Determines if the sender currently disabled the viewer's annotation or not.
(MobileRTCAnnotationError)	- disableViewerAnnotation:
	Enables or disables viewer's annotation.
(BOOL)	- isAnnotationLegalNoticeAvailable
	Determines if annotation legal notice is available.
(NSString *_Nullable)	- getAnnotationLegalNoticesPrompt
	Gets the annotation over share legal notices prompt.
(NSString *_Nullable)	- getAnnotationLegalNoticesExplained
	Gets the 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 106 of file MobileRTCAnnotationService.h.

Method Documentation

canDisableViewerAnnotation

- (BOOL) canDisableViewerAnnotation

Determines if it supports disabling viewer's annotation item.

Returns

YES if supported. Otherwise, NO.

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

Referenced by canDisableViewerAnnotation.

canDoAnnotation:

- (BOOL) canDoAnnotation:

(nullable UIView *)

shareView

Determines if the current shareView can do annotation or not.

Parameters

shareView

The shared view.

Returns

YES if annotation can be done. Otherwise, NO.

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

Enables or disables viewer's annotation.

Parameters

isDisable

YES to disable, NO to enable.

Returns

MobileRTCAnnotationError_Successed if the operation succeeds.

getAnnotationLegalNoticesExplained

- (NSString *_Nullable) getAnnotationLegalNoticesExplained

Gets the annotation over share legal notices explained.

Returns

The annotation over share legal notices explained.

Referenced by canDisableViewerAnnotation.

getAnnotationLegalNoticesPrompt

- (NSString *_Nullable) getAnnotationLegalNoticesPrompt

Gets the annotation over share legal notices prompt.

Returns

The annotation over share legal notices prompt.

Referenced by canDisableViewerAnnotation.

getToolColor

- (nullable UIColor *) getToolColor

Gets the current annotation tool color.

Returns

The color by tool type.

Referenced by canDisableViewerAnnotation.

getToolType

- (MobileRTCAnnoTool) getToolType

Gets the annotation tool type.

Returns

The current tool type.

Referenced by canDisableViewerAnnotation.

getToolWidth

- (NSUInteger) getToolWidth

Gets the annotation tool width.

Returns

The current tool width.

Referenced by canDisableViewerAnnotation.

isAnnotationLegalNoticeAvailable

- (BOOL) isAnnotationLegalNoticeAvailable

Determines if annotation legal notice is available.

Returns

YES if available. Otherwise, NO.

Referenced by canDisableViewerAnnotation.

isPresenter

- (BOOL) isPresenter

Determines if the current user is the presenter.

Returns

YES if the user is the presenter. Otherwise, NO.

Warning

That need to start annotation first.

Referenced by canDisableViewerAnnotation.

isViewerAnnotationDisabled

- (BOOL) isViewerAnnotationDisabled

Determines if the sender currently disabled the viewer's annotation or not.

Returns

YES if viewer's annotation is disabled. Otherwise, NO.

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

Sets the colors of annotation tools.

Returns

The result of setting the colors.

setToolType:

- (MobileRTCAnnotationError) setToolType:

(MobileRTCAnnoTool)

type

Sets 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

Sets the line width of annotation tools.

Returns

The result of operation.

startAnnotationWithSharedView:

- (MobileRTCAnnotationError) startAnnotationWithSharedView:

(nullable UIView *)

shareView

Starts annotations on the shared view.

Parameters

shareView

The shared view.

Returns

The result of operation.

stopAnnotation

- (BOOL) stopAnnotation

Stops 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 111 of file MobileRTCAnnotationService.h.

Referenced by canDisableViewerAnnotation.