Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

AnnotationManager

vncsdk.AnnotationManager

Enables a Viewer or Server to annotate a Server device screen.

Method Summary

Modifier and Type Method and Description

clear(fade, connection)

Clears particular annotations.

clearAll(fade)

Clears all annotations.
number

getFadeDuration()

Gets how long annotations take to fade.
number

getPenColor()

Gets the current pen color.
number

getPenSize()

Gets the current pen size.
number

getPersistDuration()

Gets how long annotations persist as a solid color for.
boolean

isAvailable()

Queries whether it is possible to annotate.

movePenTo(x, y, penDown)

Draws a line on the Server screen from the current position to a new position.

setCallback(callback)

Sets annotation-related callbacks.

setFadeDuration(durationMs)

Sets how long annotations take to fade.

setPenColor(color)

Sets the pen color, determining the color of the annotation line.

setPenSize(size)

Sets the pen size, determining the width of the annotation line.

setPersistDuration(durationMs)

Sets how long annotations persist as a solid color for.

Methods

AnnotationManager.clear(fade, connection)

Clears particular annotations.

For more information, see vnc_AnnotationManager_clear().

Arguments:
Throws:

vncsdk.VncException on error
AnnotationManager.clearAll(fade)

Clears all annotations.

For more information, see vnc_AnnotationManager_clearAll().

Arguments:
  • fade (boolean) –
AnnotationManager.getFadeDuration()

Gets how long annotations take to fade.

For more information, see vnc_AnnotationManager_getFadeDuration().

Return type:number
AnnotationManager.getPenColor()

Gets the current pen color.

For more information, see vnc_AnnotationManager_getPenColor().

Return type:number
AnnotationManager.getPenSize()

Gets the current pen size.

For more information, see vnc_AnnotationManager_getPenSize().

Return type:number
AnnotationManager.getPersistDuration()

Gets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_getPersistDuration().

Return type:number
AnnotationManager.isAvailable()

Queries whether it is possible to annotate.

For more information, see vnc_AnnotationManager_isAvailable().

Return type:boolean
AnnotationManager.movePenTo(x, y, penDown)

Draws a line on the Server screen from the current position to a new position.

For more information, see vnc_AnnotationManager_movePenTo().

Arguments:
  • x (number) –
  • y (number) –
  • penDown (boolean) –
Throws:

vncsdk.VncException on error
AnnotationManager.setCallback(callback)

Sets annotation-related callbacks.

For more information, see vnc_AnnotationManager_setCallback().

Arguments:
Throws:

vncsdk.VncException on error
AnnotationManager.setFadeDuration(durationMs)

Sets how long annotations take to fade.

For more information, see vnc_AnnotationManager_setFadeDuration().

Arguments:
  • durationMs (number) –
AnnotationManager.setPenColor(color)

Sets the pen color, determining the color of the annotation line.

For more information, see vnc_AnnotationManager_setPenColor().

Arguments:
  • color (number) –
AnnotationManager.setPenSize(size)

Sets the pen size, determining the width of the annotation line.

For more information, see vnc_AnnotationManager_setPenSize().

Arguments:
  • size (number) –
AnnotationManager.setPersistDuration(durationMs)

Sets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_setPersistDuration().

Arguments:
  • durationMs (number) –
×