us.zoom.sdk.InMeetingAnnotationController Interface Reference

Annotation controls in meeting. More...

Data Structures
enum	AnnotationToolType
	Type of annotation tools. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931. More...
interface	InMeetingAnnotationListener
	Callback event of meeting annotation share. More...

Public Member Functions
void	addListener (InMeetingAnnotationController.InMeetingAnnotationListener listener)
	Register a listener for meeting shared callback event.
void	removeListener (InMeetingAnnotationController.InMeetingAnnotationListener listener)
	Unregister the listener.
MobileRTCSDKError	startAnnotation ()
	Start to annotate.
MobileRTCSDKError	stopAnnotation ()
	Stop current annotation.
MobileRTCSDKError	setToolColor (int color)
	Set the colors of annotation tools.
MobileRTCSDKError	setToolType (AnnotationToolType toolType)
	Set the types of annotation tools.
MobileRTCSDKError	setToolWidth (int width)
	Set the line width of annotation tool.
MobileRTCSDKError	clear ()
	Clear annotations.
MobileRTCSDKError	undo ()
	Undo the last annotation.
MobileRTCSDKError	redo ()
	Redo the last annotation.
boolean	isPresenter ()
	Query if the current user himself is presenter.
boolean	canDisableViewerAnnotation ()
	Query if support to disable viewer's annotation item.
boolean	isViewerAnnotationDisabled ()
	Query currently sender disabled the viewer's annotation or not.
boolean	canDoAnnotation ()
	Query can do annotation or not.
MobileRTCSDKError	disableViewerAnnotation (boolean isDisable)
	disable viewer's annotation.
boolean	isAnnotationLegalNoticeAvailable ()
	Whether annotation legal notice is available.
String	getAnnotationLegalNoticesPrompt ()
	Return annotation legal notice prompt.
String	getAnnotationLegalNoticesExplained ()
	Return explained text for annotation legal notice.

Detailed Description

Annotation controls in meeting.

Definition at line 9 of file InMeetingAnnotationController.java.

Member Function Documentation

addListener()

void us.zoom.sdk.InMeetingAnnotationController.addListener

(

InMeetingAnnotationController.InMeetingAnnotationListener

listener

)

Register a listener for meeting shared callback event.

Parameters

listener

The listener instance.

canDisableViewerAnnotation()

boolean us.zoom.sdk.InMeetingAnnotationController.canDisableViewerAnnotation

(

)

Query if support to disable viewer's annotation item.

Returns

true if support.

canDoAnnotation()

boolean us.zoom.sdk.InMeetingAnnotationController.canDoAnnotation

(

)

Query can do annotation or not.

Returns

true if can do the annotation

clear()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.clear

(

)

Clear annotations.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

disableViewerAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.disableViewerAnnotation

(

boolean

isDisable

)

disable viewer's annotation.

Parameters

isDisable

If disable viewer annotation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

getAnnotationLegalNoticesExplained()

String us.zoom.sdk.InMeetingAnnotationController.getAnnotationLegalNoticesExplained

(

)

Return explained text for annotation legal notice.

Returns

explained text for notice

getAnnotationLegalNoticesPrompt()

String us.zoom.sdk.InMeetingAnnotationController.getAnnotationLegalNoticesPrompt

(

)

Return annotation legal notice prompt.

Returns

notice prompt

isAnnotationLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingAnnotationController.isAnnotationLegalNoticeAvailable

(

)

Whether annotation legal notice is available.

Returns

True if annotation legal notice is available

isPresenter()

boolean us.zoom.sdk.InMeetingAnnotationController.isPresenter

(

)

Query if the current user himself is presenter.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

isViewerAnnotationDisabled()

boolean us.zoom.sdk.InMeetingAnnotationController.isViewerAnnotationDisabled

(

)

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

Returns

true if disabled viewer's annotation.

redo()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.redo

(

)

Redo the last annotation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

removeListener()

void us.zoom.sdk.InMeetingAnnotationController.removeListener

(

InMeetingAnnotationController.InMeetingAnnotationListener

listener

)

Unregister the listener.

Parameters

listener

The listener instance

setToolColor()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolColor

(

int

color

)

Set the colors of annotation tools.

Parameters

color

Specify the color of the annotation tools.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setToolType()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolType

(

AnnotationToolType

toolType

)

Set the types of annotation tools.

Parameters

toolType

Set the tool types defined in AnnotationToolType.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setToolWidth()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolWidth

(

int

width

)

Set the line width of annotation tool.

Parameters

width

Specify the value of line width.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

startAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.startAnnotation

(

)

Start to annotate.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

stopAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.stopAnnotation

(

)

Stop current annotation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

undo()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.undo

(

)

Undo the last annotation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.