Class ZoomVideoSdkAnnotationHelper

Implements

ZoomVideoSdkAnnotationHelperType

Index

Constructors

Methods

canDoAnnotation clear getToolColor getToolType getToolWidth isSenderDisableAnnotation redo setToolColor setToolType setToolWidth startAnnotation stopAnnotation undo

Constructors

constructor

new ZoomVideoSdkAnnotationHelper(): ZoomVideoSdkAnnotationHelper
Returns ZoomVideoSdkAnnotationHelper

Methods

canDoAnnotation

canDoAnnotation(): Promise<any>
Whether the current user can do annotation on the share.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.canDoAnnotation
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:81

clear

clear(clearType: string): Promise<any>
Clears the annotations.
Parameters
- clearType: string
Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.clear
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:125

getToolColor

getToolColor(): Promise<any>
Gets the current tool color for annotations.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.getToolColor
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:93

getToolType

getToolType(): Promise<any>
Gets the current tool type for annotations.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.getToolType
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:97

getToolWidth

getToolWidth(): Promise<any>
Gets the current tool width for annotations.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.getToolWidth
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:101

isSenderDisableAnnotation

isSenderDisableAnnotation(): Promise<any>
Returns Promise<any>
Deprecated
Use canDoAnnotation instead.
Implementation of ZoomVideoSdkAnnotationHelperType.isSenderDisableAnnotation
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:77

redo

redo(): Promise<any>
Redoes the last undone action.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.redo
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:121

setToolColor

setToolColor(toolColor: string): Promise<any>
Sets the tool color for annotations.
Parameters
- toolColor: string
Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.setToolColor
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:105

setToolType

setToolType(toolType: string): Promise<any>
Sets the tool type for annotations.
Parameters
- toolType: string
Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.setToolType
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:109

setToolWidth

setToolWidth(width: number): Promise<any>
Sets the tool width for annotations.
Parameters
- width: number
Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.setToolWidth
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:113

startAnnotation

startAnnotation(): Promise<any>
Start annotation.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.startAnnotation
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:85

stopAnnotation

stopAnnotation(): Promise<any>
Stop annotation.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.stopAnnotation
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:89

undo

undo(): Promise<any>
Undoes the last action.

Returns Promise<any>
Implementation of ZoomVideoSdkAnnotationHelperType.undo
- Defined in src/native/ZoomVideoSdkAnnotationHelper.ts:117