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
void

Library.Init(Library.EventLoopType)

Initializes the VNC SDK and sets the event loop type.

void

Library.EnableAddOn(String)

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

void

Library.SetCloudProxySettings(Boolean, String)

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

String

Library.GetLastError()

Gets the error produced by the last API call.

Int32

Library.GetMajorVersion()

Returns the runtime major version number of the SDK.

Int32

Library.GetMinorVersion()

Returns the runtime minor version number of the SDK.

Int32

Library.GetPatchVersion()

Returns the runtime patch version number of the SDK.

Int32

Library.GetBuildNumber()

Returns the runtime build number of the SDK.

void

Library.Shutdown()

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

void

Library.InitInternal(Int32, Int32, Int32, Int32, Library.EventLoopType)

This should not be called directly, instead the init() macro should be used.

Int32

Library.UnicodeToKeysym(Int32)

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

Methods

void Library.Init (Library.EventLoopType a)

Initializes the VNC SDK and sets the event loop type.

void Library.EnableAddOn (String a)

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.

void Library.SetCloudProxySettings (Boolean a, String b)

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.

String Library.GetLastError ()

Gets the error produced by the last API call.

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

Int32 Library.GetMajorVersion ()

Returns the runtime major version number of the SDK.

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

Int32 Library.GetMinorVersion ()

Returns the runtime minor version number of the SDK.

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

Int32 Library.GetPatchVersion ()

Returns the runtime patch version number of the SDK.

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

Int32 Library.GetBuildNumber ()

Returns the runtime build number of the SDK.

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

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.

void Library.InitInternal (Int32 a, Int32 b, Int32 c, Int32 d, Library.EventLoopType e)

This should not be called directly, instead the init() macro should be used.

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

Int32 Library.UnicodeToKeysym (Int32 a)

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

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

×