Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

AnnotationManager

class 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.

clear_all(fade)

Clears all annotations.
int

get_fade_duration()

Gets how long annotations take to fade.
int

get_pen_color()

Gets the current pen color.
int

get_pen_size()

Gets the current pen size.
int

get_persist_duration()

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

is_available()

Queries whether it is possible to annotate.

move_pen_to(x, y, pen_down)

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

set_callback(callback)

Sets annotation-related callbacks.

set_fade_duration(duration_ms)

Sets how long annotations take to fade.

set_pen_color(color)

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

set_pen_size(size)

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

set_persist_duration(duration_ms)

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().

Parameters:
AnnotationManager.clear_all(fade)

Clears all annotations.

For more information, see vnc_AnnotationManager_clearAll().

Parameters:fade (bool) –
AnnotationManager.get_fade_duration()

Gets how long annotations take to fade.

For more information, see vnc_AnnotationManager_getFadeDuration().

Return type:int
AnnotationManager.get_pen_color()

Gets the current pen color.

For more information, see vnc_AnnotationManager_getPenColor().

Return type:int
AnnotationManager.get_pen_size()

Gets the current pen size.

For more information, see vnc_AnnotationManager_getPenSize().

Return type:int
AnnotationManager.get_persist_duration()

Gets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_getPersistDuration().

Return type:int
AnnotationManager.is_available()

Queries whether it is possible to annotate.

For more information, see vnc_AnnotationManager_isAvailable().

Return type:bool
AnnotationManager.move_pen_to(x, y, pen_down)

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

For more information, see vnc_AnnotationManager_movePenTo().

Parameters:
  • x (int) –
  • y (int) –
  • pen_down (bool) –
AnnotationManager.set_callback(callback)

Sets annotation-related callbacks.

For more information, see vnc_AnnotationManager_setCallback().

Parameters:callback (vncsdk.AnnotationManager.Callback or None) –
AnnotationManager.set_fade_duration(duration_ms)

Sets how long annotations take to fade.

For more information, see vnc_AnnotationManager_setFadeDuration().

Parameters:duration_ms (int) –
AnnotationManager.set_pen_color(color)

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

For more information, see vnc_AnnotationManager_setPenColor().

Parameters:color (int) –
AnnotationManager.set_pen_size(size)

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

For more information, see vnc_AnnotationManager_setPenSize().

Parameters:size (int) –
AnnotationManager.set_persist_duration(duration_ms)

Sets how long annotations persist as a solid color for.

For more information, see vnc_AnnotationManager_setPersistDuration().

Parameters:duration_ms (int) –
×