iOS API
Instance Methods | Properties | List of all members
MobileRTCAnnotationService Class Reference
Inheritance diagram for MobileRTCAnnotationService:

Instance Methods

(MobileRTCAnnotationError) - startAnnotationWithSharedView:
 Set to start annotations on the shared view. More...
 
(BOOL) - stopAnnotation
 Set to stop annotations. More...
 
(MobileRTCAnnotationError) - setToolColor:
 Set the colors of annotation tools. More...
 
(nullable UIColor *) - getToolColor:
 This method is used to get current Anno Tool Color. More...
 
(MobileRTCAnnotationError) - setToolType:
 Set the types of annotation tools.
More...
 
(MobileRTCAnnotationError) - setToolWidth:
 Set the line width of annotation tools.
More...
 
(MobileRTCAnnotationError) - clear
 Set to clear the annotations.
More...
 
(MobileRTCAnnotationError) - undo
 Undo the last annotation.
More...
 
(MobileRTCAnnotationError) - redo
 Redo the last annotation. More...
 
(nullable NSArray *) - getSupportedToolType
 Get the supported tool types. More...
 
(BOOL) - isPresenter
 Check if the current user is the presenter. More...
 
(BOOL) - canDisableViewerAnnoataion
 Check if support to disable viewer's annotation item. More...
 
(BOOL) - isViewerAnnoataionDisabled
 Check currently sender disabled the viewer's annotation or not. More...
 
(MobileRTCAnnotationError) - disableViewerAnnoataion:
 disable viewer's annotation. More...
 
(BOOL) - canDoAnnotation
 Check can do annotation or not. More...
 

Properties

id< MobileRTCAnnotationServiceDelegatedelegate
 Callback of receiving meeting events.
 

Method Documentation

◆ canDisableViewerAnnoataion()

- (BOOL) canDisableViewerAnnoataion

Check if support to disable viewer's annotation item.

Returns
Yes if support.

◆ canDoAnnotation()

- (BOOL) canDoAnnotation

Check can do annotation or not.

Returns
Yes if can do the annotation.

◆ clear()

- (MobileRTCAnnotationError) clear

Set to clear the annotations.

Returns
The result of operation.
Warning
Check firstly if the tool is supported via getSupportedToolType.

◆ disableViewerAnnoataion:()

- (MobileRTCAnnotationError) disableViewerAnnoataion: (BOOL)  isDisable

disable viewer's annotation.

Returns
MobileRTCAnnotationError_Successed if disabled the viewer's annotation success.

◆ getSupportedToolType()

- (nullable NSArray *) getSupportedToolType

Get the supported tool types.

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

◆ getToolColor:()

- (nullable UIColor *) getToolColor: (MobileRTCAnnoTool)  tooltype

This method is used to get current Anno Tool Color.

Returns
Get Color by tool type.

◆ isPresenter()

- (BOOL) isPresenter

Check if the current user is the presenter.

Returns
Yes if be presenter.

◆ isViewerAnnoataionDisabled()

- (BOOL) isViewerAnnoataionDisabled

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

Returns
Yes if disabled viewer's annotation.

◆ redo()

- (MobileRTCAnnotationError) redo

Redo the last annotation.

Returns
The result of redoing the annotations.
Warning
Check firstly if the tool is supported via getSupportedToolType.

◆ 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
viewThe shared view.
Returns
The result of operation.

◆ stopAnnotation()

- (BOOL) stopAnnotation

Set to stop annotations.

Returns
The result of operation.

◆ undo()

- (MobileRTCAnnotationError) undo

Undo the last annotation.

Returns
The result of undoing the annotations.
Warning
Check firstly if the tool is supported via getSupportedToolType.

The documentation for this class was generated from the following file: