Learn how to evaluate and integrate the VNC SDK
Library¶
-
public final class
Library¶ A class containing SDK global properties and methods.
Nested Classes¶
- class
Library.DestroyedObjectException - enum
Library.EventLoopType - class
Library.VncException
Method Summary¶
| Modifier and Type | Method and Description |
|---|---|
void |
Enable an SDK add-on by passing in the content of the add-on code, obtained from RealVNC. |
int |
Returns the runtime build number of the SDK. |
int |
Returns the runtime major version number of the SDK. |
int |
Returns the runtime minor version number of the SDK. |
int |
Returns the runtime patch version number of the SDK. |
void |
Initializes the SDK with the default |
void |
Initializes the SDK, as for |
void |
Initializes the SDK, as for |
int |
Converts a keysym to a unicode - suitable for converting a keysym received on the server in |
void |
Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections. |
void |
Shuts down the SDK, ensuring that any resources are cleared up. |
int |
Converts a unicode character to a keysym, suitable for passing to |
Fields¶
-
public static final int
VNC_DIRECT_TCP_DEFAULT_PORT¶ The default port for VNC direct TCP connections.
Deprecated: use
DirectTcp.DEFAULT_PORTinstead.
Methods¶
-
public static void
enableAddOn(String addOnCode) throws Library.VncException¶ Enable an SDK add-on by passing in the content of the add-on code, obtained from RealVNC.
For more information, see
vnc_enableAddOn().
-
public static int
getBuildNumber()¶ Returns the runtime build number of the SDK.
For more information, see
vnc_getBuildNumber().
-
public static int
getMajorVersion()¶ Returns the runtime major version number of the SDK.
For more information, see
vnc_getMajorVersion().
-
public static int
getMinorVersion()¶ Returns the runtime minor version number of the SDK.
For more information, see
vnc_getMinorVersion().
-
public static int
getPatchVersion()¶ Returns the runtime patch version number of the SDK.
For more information, see
vnc_getPatchVersion().
-
public static void
init() throws Library.VncException¶ Initializes the SDK with the default
Library.EventLoopTypefor the platform. Only call functions inDataStoreorLoggerbefore you call this function.
-
public static void
init(EventLoopType eventLoopType) throws Library.VncException¶ Initializes the SDK, as for
init. This is used in the case where the default event loop type is not desired.
-
public static void
init(EventLoopType eventLoopType, boolean assertions) throws Library.VncException¶ Initializes the SDK, as for
init. This is used in the case where the default event loop type is not desired, and the user wishes to suppress assertions.
-
public static int
keysymToUnicode(int 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().
-
public static void
setCloudProxySettings(boolean systemProxy, String proxyUrl) throws Library.VncException¶ Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections.
For more information, see
vnc_setCloudProxySettings().
-
public static void
shutdown() throws Library.VncException¶ Shuts down the SDK, ensuring that any resources are cleared up.
For more information, see
vnc_shutdown().
-
public static int
unicodeToKeysym(int unicodeChar)¶ Converts a unicode character to a keysym, suitable for passing to
Viewer.sendKeyDown().For more information, see
vnc_unicodeToKeysym().