Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

AnnotationManager

public abstract class AnnotationManager

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

Nested Classes

Method Summary

Modifier and Type Method and Description
void

clear(boolean fade, Connection connection)

Clears particular annotations.
void

clearAll(boolean fade)

Clears all annotations.
int

getFadeDuration()

Gets how long annotations take to fade.
int

getPenColor()

Gets the current pen color.
int

getPenSize()

Gets the current pen size.
int

getPersistDuration()

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

isAvailable()

Queries whether it is possible to annotate.
void

movePenTo(int x, int y, boolean penDown)

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

setCallback(AnnotationManager.Callback callback)

Sets annotation-related callbacks.
void

setFadeDuration(int durationMs)

Sets how long annotations take to fade.
void

setPenColor(int color)

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

setPenSize(int size)

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

setPersistDuration(int durationMs)

Sets how long annotations persist as a solid color for.

Methods

public void clear(boolean fade, Connection connection) throws Library.VncException

Clears particular annotations.

For more information, see vnc_AnnotationManager_clear().

public void clearAll(boolean fade)

Clears all annotations.

For more information, see vnc_AnnotationManager_clearAll().

public int getFadeDuration()

Gets how long annotations take to fade.

For more information, see vnc_AnnotationManager_getFadeDuration().

public int getPenColor()

Gets the current pen color.

For more information, see vnc_AnnotationManager_getPenColor().

public int getPenSize()

Gets the current pen size.

For more information, see vnc_AnnotationManager_getPenSize().

public int getPersistDuration()

Gets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_getPersistDuration().

public boolean isAvailable()

Queries whether it is possible to annotate.

For more information, see vnc_AnnotationManager_isAvailable().

public void movePenTo(int x, int y, boolean penDown) throws Library.VncException

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

For more information, see vnc_AnnotationManager_movePenTo().

public void setCallback(AnnotationManager.Callback callback) throws Library.VncException

Sets annotation-related callbacks.

For more information, see vnc_AnnotationManager_setCallback().

public void setFadeDuration(int durationMs)

Sets how long annotations take to fade.

For more information, see vnc_AnnotationManager_setFadeDuration().

public void setPenColor(int color)

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

For more information, see vnc_AnnotationManager_setPenColor().

public void setPenSize(int size)

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

For more information, see vnc_AnnotationManager_setPenSize().

public void setPersistDuration(int durationMs)

Sets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_setPersistDuration().

×