ZoomSDKAnnotationController Class Reference

Controls Zoom UI annotation features in Zoom meetings, including setting tools, clearing annotations, and managing annotation states. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931. More...

#include <ZoomSDKASController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isAnnotationDisable
	Determines if annotation disabled.
(ZoomSDKError)	- setTool:onScreen:
	Sets annotation tool type.
(ZoomSDKError)	- clear:onScreen:
	Clears the annotation of share screen.
(ZoomSDKError)	- setColor:Green:Black:onScreen:
	Sets annotation color.
(ZoomSDKError)	- setColor:green:blue:onScreen:
	Sets annotation color.
(ZoomSDKError)	- setLineWidth:onScreen:
	Sets the line's width for the annotation.
(ZoomSDKError)	- undo:
	Undo annotation.
(ZoomSDKError)	- redo:
	Redo annotation.
(BOOL)	- isAnnotationLegalNoticeAvailable
	Determines whether the legal notice for annotation is available.
(NSString *)	- getAnnotationLegalNoticesPrompt
	Gets the annotation legal notices prompt.
(NSString *)	- getAnnotationLegalNoticesExplained
	Gets the annotation legal notices explained.

Detailed Description

Controls Zoom UI annotation features in Zoom meetings, including setting tools, clearing annotations, and managing annotation states. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931.

Definition at line 17 of file ZoomSDKASController.h.

Method Documentation

clear:onScreen:

- (ZoomSDKError) clear:		(AnnotationClearType)	type
onScreen:		(ScreenType)	screen

Clears the annotation of share screen.

Parameters

type	Specify the type of clear annotation.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getAnnotationLegalNoticesExplained

- (NSString *) getAnnotationLegalNoticesExplained

Gets the annotation legal notices explained.

Returns

If the function succeeds, it returns the annotation legal notices explained. Otherwise, this function fails and returns nil.

References getAnnotationLegalNoticesExplained.

Referenced by getAnnotationLegalNoticesExplained.

getAnnotationLegalNoticesPrompt

- (NSString *) getAnnotationLegalNoticesPrompt

Gets the annotation legal notices prompt.

Returns

If the function succeeds, it returns the annotation legal notices prompt. Otherwise, this function fails and returns nil.

References getAnnotationLegalNoticesPrompt.

Referenced by getAnnotationLegalNoticesPrompt.

isAnnotationDisable

- (BOOL) isAnnotationDisable

Determines if annotation disabled.

Returns

YES if annotation is disabled. Otherwise, NO.

References isAnnotationDisable.

Referenced by isAnnotationDisable.

isAnnotationLegalNoticeAvailable

- (BOOL) isAnnotationLegalNoticeAvailable

Determines whether the legal notice for annotation is available.

Returns

YES if the legal notice for annotation transcript is available. Otherwise, NO.

References isAnnotationLegalNoticeAvailable.

Referenced by isAnnotationLegalNoticeAvailable.

redo:

- (ZoomSDKError) redo:

(ScreenType)

screen

Redo annotation.

Parameters

screen

Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setColor:Green:Black:onScreen:

- (ZoomSDKError) setColor:		(float)	red
Green:		(float)	green
Black:		(float)	black
onScreen:		(ScreenType)	screen

Sets annotation color.

Parameters

red	The value of red, range is 0 to 1.
green	The value of green, range is 0 to 1.
black	The value of blue (legacy parameter name), range is 0 to 1.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Deprecated

Use setColor:green:blue:onScreen: instead.

setColor:green:blue:onScreen:

- (ZoomSDKError) setColor:		(float)	red
green:		(float)	green
blue:		(float)	blue
onScreen:		(ScreenType)	screen

Sets annotation color.

Parameters

red	Red color component, range is 0 to 255.
green	Green color component, range is 0 to 255.
blue	Blue color component, range is 0 to 255.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setLineWidth:onScreen:

- (ZoomSDKError) setLineWidth:		(long)	lineWidth
onScreen:		(ScreenType)	screen

Sets the line's width for the annotation.

Parameters

lineWidth	The line width.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setTool:onScreen:

- (ZoomSDKError) setTool:		(AnnotationToolType)	type
onScreen:		(ScreenType)	screen

Sets annotation tool type.

Parameters

type	The specify annotation tool type.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Warning

The tool type AnnotationToolType_Picker and AnnotationToolType_SpotLight are not support for viewer.

undo:

- (ZoomSDKError) undo:

(ScreenType)

screen

Undo annotation.

Parameters

screen

Select the screen where you want to operate on.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.