ZoomSDKAnnotationController Class Reference

ZOOM UI annotation class. More...

#import <ZoomSDKASController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isAnnotationDisable
	Determine if annotation disabled.
(ZoomSDKError)	- setTool:onScreen:
	Set annotation tool type.
(ZoomSDKError)	- clear:onScreen:
	Clear the annotation of share screen.
(ZoomSDKError)	- setColor:Green:Black:onScreen:
	Set annotation color.
(ZoomSDKError)	- setLineWidth:onScreen:
	Set the width of the line for the annotation.
(ZoomSDKError)	- undo:
	Undo annotation.
(ZoomSDKError)	- redo:
	Redo annotation.
(BOOL)	- isAnnotationLegalNoticeAvailable
	Determine whether the legal notice for annotation is available.
(NSString *)	- getAnnotationLegalNoticesPrompt
	Get the annotation legal notices prompt.
(NSString *)	- getAnnotationLegalNoticesExplained
	Get the annotation legal notices explained.

Detailed Description

ZOOM UI annotation class.

Definition at line 11 of file ZoomSDKASController.h.

Method Documentation

clear:onScreen:

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

Clear 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, the return value is ZoomSDKError_Success. Otherwise failed.

getAnnotationLegalNoticesExplained

- (NSString *) getAnnotationLegalNoticesExplained

Get the annotation legal notices explained.

Returns

If the function succeeds, it will return the annotation legal notices explained. Otherwise nil.

getAnnotationLegalNoticesPrompt

- (NSString *) getAnnotationLegalNoticesPrompt

Get the annotation legal notices prompt.

Returns

If the function succeeds, it will return the annotation legal notices prompt. Otherwise nil.

isAnnotationDisable

- (BOOL) isAnnotationDisable

Determine if annotation disabled.

isAnnotationLegalNoticeAvailable

- (BOOL) isAnnotationLegalNoticeAvailable

Determine whether the legal notice for annotation is available.

Returns

YES indicates the legal notice for annotation transcript is available. Otherwise not.

redo:

- (ZoomSDKError) redo:

(ScreenType)

screen

Redo annotation.

Parameters

screen

Select the screen where you want to operate on.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setColor:Green:Black:onScreen:

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

Set annotation color.

Parameters

red	The value of red.
green	The value of green.
black	The value of black.
screen	Select the screen where you want to operate on.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setLineWidth:onScreen:

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

Set the width of the line for the annotation.

Parameters

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

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setTool:onScreen:

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

Set annotation tool type.

Parameters

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

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

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, the return value is ZoomSDKError_Success. Otherwise failed.