Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

Library

class Library

A class containing SDK global properties and methods.

Nested classes

Method summary

Modifier and Type Method and Description
static void

Library.Init(Library.EventLoopType eventLoopType = RealVNC.VncSdk.Library.EventLoopType.Default)

Initializes the VNC SDK and sets the event loop type.
static void

Library.EnableAddOn(String addOnCode)

Enable an SDK add-on by passing in the content of the add-on code, obtained from RealVNC.
static void

Library.SetCloudProxySettings(Boolean systemProxy, String proxyUrl)

Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections.
static String

Library.GetLastError()

Gets the error produced by the last API call.
static Int32

Library.GetMajorVersion()

Returns the runtime major version number of the SDK.
static Int32

Library.GetMinorVersion()

Returns the runtime minor version number of the SDK.
static Int32

Library.GetPatchVersion()

Returns the runtime patch version number of the SDK.
static Int32

Library.GetBuildNumber()

Returns the runtime build number of the SDK.
static void

Library.Shutdown()

Shuts down the SDK, ensuring that any resources are cleared up.
static Int32

Library.UnicodeToKeysym(Int32 unicodeChar)

Converts a unicode character to a keysym, suitable for passing to Viewer.sendKeyDown().
static Int32

Library.KeysymToUnicode(Int32 keysym)

Converts a keysym to a unicode - suitable for converting a keysym received on the server in Server.InputEventsCallback::keyEventCallback.

Methods

static void Library.Init (Library.EventLoopType eventLoopType = RealVNC.VncSdk.Library.EventLoopType.Default)

Initializes the VNC SDK and sets the event loop type.

static void Library.EnableAddOn (String addOnCode)

Enable an SDK add-on by passing in the content of the add-on code, obtained from RealVNC.

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

static void Library.SetCloudProxySettings (Boolean systemProxy, String proxyUrl)

Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections.

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

static String Library.GetLastError ()

Gets the error produced by the last API call.

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

static Int32 Library.GetMajorVersion ()

Returns the runtime major version number of the SDK.

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

static Int32 Library.GetMinorVersion ()

Returns the runtime minor version number of the SDK.

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

static Int32 Library.GetPatchVersion ()

Returns the runtime patch version number of the SDK.

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

static Int32 Library.GetBuildNumber ()

Returns the runtime build number of the SDK.

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

static void Library.Shutdown ()

Shuts down the SDK, ensuring that any resources are cleared up.

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

static Int32 Library.UnicodeToKeysym (Int32 unicodeChar)

Converts a unicode character to a keysym, suitable for passing to Viewer.sendKeyDown().

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

static Int32 Library.KeysymToUnicode (Int32 keysym)

Converts a keysym to a unicode - suitable for converting a keysym received on the server in Server.InputEventsCallback::keyEventCallback.

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

×