InMeetingAnnotationController (Zoom.us SDK API Document)

public interface InMeetingAnnotationController

Annotation controls in meeting.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InMeetingAnnotationController.AnnotationToolType` Annotation tool types in meeting.
`static interface`	`InMeetingAnnotationController.InMeetingAnnotationListener` Callback event of meeting annotaion share.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(InMeetingAnnotationController.InMeetingAnnotationListener listener)` Register a listener for meeting shared callback event.
`boolean`	`canDisableViewerAnnotation()` Query if support to disable viewer's annotation item.
`boolean`	`canDoAnnotation()` Query can do annotation or not.
`MobileRTCSDKError`	`clear()` Clear annotations.
`MobileRTCSDKError`	`disableViewerAnnotation(boolean isDisable)` disable viewer's annotation.
`boolean`	`isPresenter()` Query if the current user himself is presenter.
`boolean`	`isViewerAnnotationDisabled()` Query currently sender disabled the viewer's annotation or not.
`MobileRTCSDKError`	`redo()` Redo the last annotation.
`void`	`removeListener(InMeetingAnnotationController.InMeetingAnnotationListener listener)` Unregister the listener.
`MobileRTCSDKError`	`setToolColor(int color)` Set the colors of annotation tools.
`MobileRTCSDKError`	`setToolType(InMeetingAnnotationController.AnnotationToolType toolType)` Set the types of annotation tools.
`MobileRTCSDKError`	`setToolWidth(int width)` Set the line width of annotation tool.
`MobileRTCSDKError`	`startAnnotation()` Start to annotate.
`MobileRTCSDKError`	`stopAnnotation()` Stop current annotation.
`MobileRTCSDKError`	`undo()` Undo the last annotation.

- Method Detail
  - addListener
```
void addListener(InMeetingAnnotationController.InMeetingAnnotationListener listener)
```
    Register a listener for meeting shared callback event.
    
    Parameters:
    
    listener - The listener instance.
  - removeListener
```
void removeListener(InMeetingAnnotationController.InMeetingAnnotationListener listener)
```
    Unregister the listener.
    
    Parameters:
    
    listener - The listener instance
  - startAnnotation
```
MobileRTCSDKError startAnnotation()
```
    Start to annotate.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - stopAnnotation
```
MobileRTCSDKError stopAnnotation()
```
    Stop current annotation.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - setToolColor
```
MobileRTCSDKError setToolColor(int color)
```
    Set the colors of annotation tools.
    
    Parameters:
    
    color - Specify the color of the annotation tools.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - setToolType
```
MobileRTCSDKError setToolType(InMeetingAnnotationController.AnnotationToolType toolType)
```
    Set the types of annotation tools.
    
    Parameters:
    
    toolType - Set the tool types defined in InMeetingAnnotationController.AnnotationToolType.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - setToolWidth
```
MobileRTCSDKError setToolWidth(int width)
```
    Set the line width of annotation tool.
    
    Parameters:
    
    width - Specify the value of line width.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - clear
```
MobileRTCSDKError clear()
```
    Clear annotations.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - undo
```
MobileRTCSDKError undo()
```
    Undo the last annotation.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - redo
```
MobileRTCSDKError redo()
```
    Redo the last annotation.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - isPresenter
```
boolean isPresenter()
```
    Query if the current user himself is presenter.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.
  - canDisableViewerAnnotation
```
boolean canDisableViewerAnnotation()
```
    Query if support to disable viewer's annotation item.
    
    Returns:
    
    TRUE if support.
  - isViewerAnnotationDisabled
```
boolean isViewerAnnotationDisabled()
```
    Query currently sender disabled the viewer's annotation or not.
    
    Returns:
    
    TRUE if disabled viewer's annotation.
  - canDoAnnotation
```
boolean canDoAnnotation()
```
    Query can do annotation or not.
    
    Returns:
    
    TRUE if can do the annotation
  - disableViewerAnnotation
```
MobileRTCSDKError disableViewerAnnotation(boolean isDisable)
```
    disable viewer's annotation.
    
    Parameters:
    
    isDisable - If disable viewer annotation.
    
    Returns:
    
    SDKERR_SUCCESS {MobileRTCSDKError if disabled the viewer's annotation success

Interface InMeetingAnnotationController

Nested Class Summary

Method Summary

Method Detail

addListener

removeListener

startAnnotation

stopAnnotation

setToolColor

setToolType

setToolWidth

clear

undo

redo

isPresenter

canDisableViewerAnnotation

isViewerAnnotationDisabled

canDoAnnotation

disableViewerAnnotation