Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

AnnotationManager

class AnnotationManager

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

For more information, see vnc_AnnotationManager in the C API documentation.

Nested classes

Method summary

Modifier and Type Method and Description
void

AnnotationManager.SetCallback(AnnotationManager.Callback callback)

Sets annotation-related callbacks.
void

AnnotationManager.Clear(Boolean fade, Connection connection)

Clears particular annotations.
void

AnnotationManager.ClearAll(Boolean fade)

Clears all annotations.
Boolean

AnnotationManager.IsAvailable()

Queries whether it is possible to annotate.
Int32

AnnotationManager.GetPenColor()

Gets the current pen color.
void

AnnotationManager.SetPenColor(Int32 color)

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

AnnotationManager.GetPenSize()

Gets the current pen size.
void

AnnotationManager.SetPenSize(Int32 size)

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

AnnotationManager.GetPersistDuration()

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

AnnotationManager.SetPersistDuration(Int32 durationMs)

Sets how long annotations persist as a solid color for.
Int32

AnnotationManager.GetFadeDuration()

Gets how long annotations take to fade.
void

AnnotationManager.SetFadeDuration(Int32 durationMs)

Sets how long annotations take to fade.
void

AnnotationManager.MovePenTo(Int32 x, Int32 y, Boolean penDown)

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

Methods

void AnnotationManager.SetCallback (AnnotationManager.Callback callback)

Sets annotation-related callbacks.

For more information, see vnc_AnnotationManager_setCallback() in the C API documentation.

void AnnotationManager.Clear (Boolean fade, Connection connection)

Clears particular annotations.

For more information, see vnc_AnnotationManager_clear() in the C API documentation.

void AnnotationManager.ClearAll (Boolean fade)

Clears all annotations.

For more information, see vnc_AnnotationManager_clearAll() in the C API documentation.

Boolean AnnotationManager.IsAvailable ()

Queries whether it is possible to annotate.

For more information, see vnc_AnnotationManager_isAvailable() in the C API documentation.

Int32 AnnotationManager.GetPenColor ()

Gets the current pen color.

For more information, see vnc_AnnotationManager_getPenColor() in the C API documentation.

void AnnotationManager.SetPenColor (Int32 color)

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

For more information, see vnc_AnnotationManager_setPenColor() in the C API documentation.

Int32 AnnotationManager.GetPenSize ()

Gets the current pen size.

For more information, see vnc_AnnotationManager_getPenSize() in the C API documentation.

void AnnotationManager.SetPenSize (Int32 size)

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

For more information, see vnc_AnnotationManager_setPenSize() in the C API documentation.

Int32 AnnotationManager.GetPersistDuration ()

Gets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_getPersistDuration() in the C API documentation.

void AnnotationManager.SetPersistDuration (Int32 durationMs)

Sets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_setPersistDuration() in the C API documentation.

Int32 AnnotationManager.GetFadeDuration ()

Gets how long annotations take to fade.

For more information, see vnc_AnnotationManager_getFadeDuration() in the C API documentation.

void AnnotationManager.SetFadeDuration (Int32 durationMs)

Sets how long annotations take to fade.

For more information, see vnc_AnnotationManager_setFadeDuration() in the C API documentation.

void AnnotationManager.MovePenTo (Int32 x, Int32 y, Boolean penDown)

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

For more information, see vnc_AnnotationManager_movePenTo() in the C API documentation.

×