Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKCustomizedAnnotation Class Reference

#import <ZoomSDKCustomizedAnnotationCtr.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- canClear:
 Query if it is able to clear annotations.
 
(ZoomSDKError- clear:
 Clear annotations.
 
(ZoomSDKError- setTool:
 Set annotation tool type.
 
(ZoomSDKError- getCurrentTool:
 Get the current annotation tool type.
 
(ZoomSDKError- setColor:
 Set the colors of annotation tools.
 
(ZoomSDKError- getCurrentColor:
 Get the color of the current annotation tools.
 
(ZoomSDKError- setLineWidth:
 Set the line width of annotation tools.
 
(ZoomSDKError- getCurrentLineWidth:
 Get the line width of the current annotation tool.
 
(ZoomSDKError- undo
 Undo the last annotation.
 
(ZoomSDKError- redo
 Redo the annotation having been deleted.
 
(ZoomSDKError- canSaveSnapshot
 Determine if it is enabled to save the snapshot.
 
(ZoomSDKError- saveSnapshot:snapshotSaveType:
 Save the snapshot in the specified path.
 

Protected Attributes

ZoomSDKShareElement_shareElement
 
id< ZoomSDKCustomizedAnnotationDelegate_delegate
 

Properties

id< ZoomSDKCustomizedAnnotationDelegatedelegate
 

Detailed Description

Definition at line 21 of file ZoomSDKCustomizedAnnotationCtr.h.

Method Documentation

◆ canClear:

- (ZoomSDKError) canClear: (AnnotationClearType clearType

Query if it is able to clear annotations.

Parameters
clearTypeSpecify the ways to clear annotations.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ canSaveSnapshot

- (ZoomSDKError) canSaveSnapshot

Determine if it is enabled to save the snapshot.

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

◆ clear:

- (ZoomSDKError) clear: (AnnotationClearType clearType

Clear annotations.

Parameters
clearTypeSpecify the way to clear annotations.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ getCurrentColor:

- (ZoomSDKError) getCurrentColor: (Color *)  color

Get the color of the current annotation tools.

Parameters
colorThe pointer to the object of color.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ getCurrentLineWidth:

- (ZoomSDKError) getCurrentLineWidth: (long *)  lineWidth

Get the line width of the current annotation tool.

Parameters
lineWidthThe pointer to the object of long.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ getCurrentTool:

- (ZoomSDKError) getCurrentTool: (AnnotationToolType *)  toolType

Get the current annotation tool type.

Parameters
toolTypeThe type of annotation tools.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ redo

- (ZoomSDKError) redo

Redo the annotation having been deleted.

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

◆ saveSnapshot:snapshotSaveType:

- (ZoomSDKError) saveSnapshot: (NSString *)  snapShotName
snapshotSaveType: (ZoomSDKAnnotationSavedType savedType 

Save the snapshot in the specified path.

Parameters
snapShotNameName of the snapshot.
savedTypeSets the type of file to save the screenshot (PNG or PDF).
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ setColor:

- (ZoomSDKError) setColor: (Color color

Set the colors of annotation tools.

Parameters
colorThe structural object of Color.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ setLineWidth:

- (ZoomSDKError) setLineWidth: (long)  lineWidth

Set the line width of annotation tools.

Parameters
lineWidthSpecify the line width to annotate.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ setTool:

- (ZoomSDKError) setTool: (AnnotationToolType toolType

Set annotation tool type.

Parameters
toolTypeThe specify annotation tool type.
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

Undo the last annotation.

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

Field Documentation

◆ _delegate

- (id<ZoomSDKCustomizedAnnotationDelegate>) _delegate
protected

Definition at line 24 of file ZoomSDKCustomizedAnnotationCtr.h.

◆ _shareElement

- (ZoomSDKShareElement*) _shareElement
protected

Definition at line 23 of file ZoomSDKCustomizedAnnotationCtr.h.

Property Documentation

◆ delegate

- (id<ZoomSDKCustomizedAnnotationDelegate>) delegate
readwritenonatomicassign

Definition at line 26 of file ZoomSDKCustomizedAnnotationCtr.h.