Annotation controls in meeting. More...

Data Structures
interface	InMeetingAnnotationListener
	Callback event of meeting annotation share. More...
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...

Public Member Functions
void	addListener (InMeetingAnnotationController.InMeetingAnnotationListener listener)
	Registers a listener for meeting shared callback events.
void	removeListener (InMeetingAnnotationController.InMeetingAnnotationListener listener)
	Unregisters the listener.
MobileRTCSDKError	startAnnotation ()
	Starts annotation.
MobileRTCSDKError	stopAnnotation ()
	Stops current annotation.
MobileRTCSDKError	setToolColor (int color)
	Sets the colors of annotation tools.
MobileRTCSDKError	setToolType (AnnotationToolType toolType)
	Sets the types of annotation tools.
MobileRTCSDKError	setToolWidth (int width)
	Sets the line width of the annotation tool.
MobileRTCSDKError	clear ()
	Clears annotations.
MobileRTCSDKError	undo ()
	Undoes the last annotation.
MobileRTCSDKError	redo ()
	Redoes the last annotation.
boolean	isPresenter ()
	Determines whether the current user is the presenter.
boolean	canDisableViewerAnnotation ()
	Determines whether it supports disabling viewer's annotation.
boolean	isViewerAnnotationDisabled ()
	Determines whether the sender has disabled the viewer's annotation.
boolean	canDoAnnotation ()
	Determines whether annotation can be done.
MobileRTCSDKError	disableViewerAnnotation (boolean isDisable)
	Disables viewer's annotation.
boolean	isAnnotationLegalNoticeAvailable ()
	Determines whether annotation legal notice is available.
String	getAnnotationLegalNoticesPrompt ()
	Gets the annotation legal notice prompt.
String	getAnnotationLegalNoticesExplained ()
	Gets the explained text for annotation legal notice.

Detailed Description

Annotation controls in meeting.

Definition at line 8 of file InMeetingAnnotationController.java.

Member Function Documentation

◆ addListener()

void us.zoom.sdk.InMeetingAnnotationController.addListener ( InMeetingAnnotationController.InMeetingAnnotationListener listener )

Registers a listener for meeting shared callback events.

Parameters

listener The listener instance.

◆ canDisableViewerAnnotation()

boolean us.zoom.sdk.InMeetingAnnotationController.canDisableViewerAnnotation ( )

Determines whether it supports disabling viewer's annotation.

Returns: true if it supports. Otherwise, false.

◆ canDoAnnotation()

boolean us.zoom.sdk.InMeetingAnnotationController.canDoAnnotation ( )

Determines whether annotation can be done.

Returns: true if annotation can be done. Otherwise, false.

◆ clear()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.clear ( )

Clears annotations.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ disableViewerAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.disableViewerAnnotation ( boolean isDisable )

Disables viewer's annotation.

Parameters

isDisable true to disable viewer annotation, false otherwise.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ getAnnotationLegalNoticesExplained()

String us.zoom.sdk.InMeetingAnnotationController.getAnnotationLegalNoticesExplained ( )

Gets the explained text for annotation legal notice.

Returns: If the function succeeds, it returns the explained text for notice. Otherwise, this function fails and returns null.

◆ getAnnotationLegalNoticesPrompt()

String us.zoom.sdk.InMeetingAnnotationController.getAnnotationLegalNoticesPrompt ( )

Gets the annotation legal notice prompt.

Returns: If the function succeeds, it returns the notice prompt. Otherwise, this function fails and returns null.

◆ isAnnotationLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingAnnotationController.isAnnotationLegalNoticeAvailable ( )

Determines whether annotation legal notice is available.

Returns: true if annotation legal notice is available. Otherwise, false.

◆ isPresenter()

boolean us.zoom.sdk.InMeetingAnnotationController.isPresenter ( )

Determines whether the current user is the presenter.

Returns: true if the current user is the presenter. Otherwise, false.

◆ isViewerAnnotationDisabled()

boolean us.zoom.sdk.InMeetingAnnotationController.isViewerAnnotationDisabled ( )

Determines whether the sender has disabled the viewer's annotation.

Returns: true if the viewer's annotation is disabled. Otherwise, false.

◆ redo()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.redo ( )

Redoes the last annotation.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ removeListener()

void us.zoom.sdk.InMeetingAnnotationController.removeListener ( InMeetingAnnotationController.InMeetingAnnotationListener listener )

Unregisters the listener.

Parameters

listener The listener instance.

◆ setToolColor()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolColor ( int color )

Sets the colors of annotation tools.

Parameters

color The color of the annotation tools.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ setToolType()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolType ( AnnotationToolType toolType )

Sets the types of annotation tools.

Parameters

toolType The tool types.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ setToolWidth()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.setToolWidth ( int width )

Sets the line width of the annotation tool.

Parameters

width The value of line width.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ startAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.startAnnotation ( )

Starts annotation.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ stopAnnotation()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.stopAnnotation ( )

Stops current annotation.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ undo()

MobileRTCSDKError us.zoom.sdk.InMeetingAnnotationController.undo ( )

Undoes the last annotation.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

Data Structures

Public Member Functions

Detailed Description

Member Function Documentation

◆ addListener()

◆ canDisableViewerAnnotation()

◆ canDoAnnotation()

◆ clear()

◆ disableViewerAnnotation()

◆ getAnnotationLegalNoticesExplained()

◆ getAnnotationLegalNoticesPrompt()

◆ isAnnotationLegalNoticeAvailable()

◆ isPresenter()

◆ isViewerAnnotationDisabled()

◆ redo()

◆ removeListener()

◆ setToolColor()

◆ setToolType()

◆ setToolWidth()

◆ startAnnotation()

◆ stopAnnotation()

◆ undo()