MobileRTCAnnotationService Class Reference

#import <MobileRTCAnnotationService.h>

Inherits NSObject.

Instance Methods
(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.
(MobileRTCAnnotationError)	- setToolWidth:
	Set the line width of annotation tools.
(MobileRTCAnnotationError)	- clear
	Set to clear the annotations.
(MobileRTCAnnotationError)	- undo
	Undo the last annotation.
(MobileRTCAnnotationError)	- redo
	Redo the last annotation.
(nullable NSArray *)	- getSupportedToolType
	Get the supported tool types.
(BOOL)	- isPresenter
	Check if the current user is the presenter.
(BOOL)	- canDisableViewerAnnoataion
	Check if support to disable viewer's annotation item.
(BOOL)	- isViewerAnnoataionDisabled
	Check currently sender disabled the viewer's annotation or not.
(MobileRTCAnnotationError)	- disableViewerAnnoataion:
	disable viewer's annotation.
(BOOL)	- canDoAnnotation
	Check can do annotation or not.
(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 >	delegate
	Callback of receiving meeting events.

Detailed Description

Definition at line 76 of file MobileRTCAnnotationService.h.

Method Documentation

canDisableViewerAnnoataion

- (BOOL) canDisableViewerAnnoataion

Check if support to disable viewer's annotation item.

Returns

Yes if support.

References canDisableViewerAnnoataion, canDoAnnotation, clear, delegate, getAnnotationLegalNoticesExplained, getAnnotationLegalNoticesPrompt, getSupportedToolType, isAnnotationLegalNoticeAvailable, isPresenter, isViewerAnnoataionDisabled, redo, stopAnnotation, and undo.

Referenced by canDisableViewerAnnoataion.

canDoAnnotation

- (BOOL) canDoAnnotation

Check can do annotation or not.

Returns

Yes if can do the annotation.

Referenced by canDisableViewerAnnoataion.

clear

- (MobileRTCAnnotationError) clear

Set to clear the annotations.

Returns

The result of operation.

Warning

Check firstly if the tool is supported via getSupportedToolType.

Referenced by canDisableViewerAnnoataion.

disableViewerAnnoataion:

- (MobileRTCAnnotationError) disableViewerAnnoataion:

(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 canDisableViewerAnnoataion.

getAnnotationLegalNoticesPrompt

- (NSString *_Nullable) getAnnotationLegalNoticesPrompt

Get annotation over share legal notices prompt.

Returns

annotation over share legal notices prompt.

Referenced by canDisableViewerAnnoataion.

getSupportedToolType

- (nullable NSArray *) getSupportedToolType

Get the supported tool types.

Returns

tool type array, each tool is a NSNumber object, value corresponding to enum MobileRTCAnnoTool.

Warning

Previous version the iPad and iPhone are different tool types of support, All tool types are now available on the iPad and iPhone, See MobileRTCAnnoTool.

Referenced by canDisableViewerAnnoataion.

getToolColor:

- (nullable UIColor *) getToolColor:

(MobileRTCAnnoTool)

tooltype

This method is used to get current Anno Tool Color.

Returns

Get Color by tool type.

isAnnotationLegalNoticeAvailable

- (BOOL) isAnnotationLegalNoticeAvailable

Is annotation legal notice available.

Returns

available or not.

Referenced by canDisableViewerAnnoataion.

isPresenter

- (BOOL) isPresenter

Check if the current user is the presenter.

Returns

Yes if be presenter.

Referenced by canDisableViewerAnnoataion.

isViewerAnnoataionDisabled

- (BOOL) isViewerAnnoataionDisabled

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

Returns

Yes if disabled viewer's annotation.

Referenced by canDisableViewerAnnoataion.

redo

- (MobileRTCAnnotationError) redo

Redo the last annotation.

Returns

The result of redoing the annotations.

Warning

Check firstly if the tool is supported via getSupportedToolType.

Referenced by canDisableViewerAnnoataion.

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

Check firstly if the tool is supported via getSupportedToolType.

setToolWidth:

- (MobileRTCAnnotationError) setToolWidth:

(NSUInteger)

width

Set the line width of annotation tools.

Returns

The result of operation.

startAnnotationWithSharedView:

- (MobileRTCAnnotationError) startAnnotationWithSharedView:

(nullable UIView *)

view

Set to start annotations on the shared view.

Parameters

view	The shared view.

Returns

The result of operation.

stopAnnotation

- (BOOL) stopAnnotation

Set to stop annotations.

Returns

The result of operation.

Referenced by canDisableViewerAnnoataion.

undo

- (MobileRTCAnnotationError) undo

Undo the last annotation.

Returns

The result of undoing the annotations.

Warning

Check firstly if the tool is supported via getSupportedToolType.

Referenced by canDisableViewerAnnoataion.

Property Documentation

delegate

- (id<MobileRTCAnnotationServiceDelegate>) delegate

readwritenonatomicassign

Callback of receiving meeting events.

Definition at line 81 of file MobileRTCAnnotationService.h.

Referenced by canDisableViewerAnnoataion.