Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

The vncsdk module

Method Summary

Modifier and Type Method and Description

init()

Initializes the SDK.

enableAddOn(addOnCode)

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

number

getBuildNumber()

Returns the runtime build number of the SDK.

number

getMajorVersion()

Returns the runtime major version number of the SDK.

number

getMinorVersion()

Returns the runtime minor version number of the SDK.

number

getPatchVersion()

Returns the runtime patch version number of the SDK.

shutdown()

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

number

unicodeToKeysym(unicodeChar)

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

Static methods

vncsdk.init()

Initializes the SDK. Only call functions in DataStore or Logger before you call this function.

Throws:vncsdk.VncException on error
vncsdk.enableAddOn(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().

Arguments:
  • addOnCode (string) –
Throws:

vncsdk.VncException on error

vncsdk.getBuildNumber()

Returns the runtime build number of the SDK.

For more information, see vnc_getBuildNumber().

Return type:number
vncsdk.getMajorVersion()

Returns the runtime major version number of the SDK.

For more information, see vnc_getMajorVersion().

Return type:number
vncsdk.getMinorVersion()

Returns the runtime minor version number of the SDK.

For more information, see vnc_getMinorVersion().

Return type:number
vncsdk.getPatchVersion()

Returns the runtime patch version number of the SDK.

For more information, see vnc_getPatchVersion().

Return type:number
vncsdk.shutdown()

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

For more information, see vnc_shutdown().

Throws:vncsdk.VncException on error
vncsdk.unicodeToKeysym(unicodeChar)

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

For more information, see vnc_unicodeToKeysym().

Arguments:
  • unicodeChar (number) –
Return type:

number

×