Learn how to evaluate and integrate the VNC SDK
The vncsdk module¶
Nested Classes¶
Method Summary¶
Modifier and Type | Method and Description |
---|---|
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. |
int |
Converts a keysym to a unicode - suitable for converting a keysym received on the server in |
Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections. |
|
Shuts down the SDK, ensuring that any resources are cleared up. |
|
int |
Converts a unicode character to a keysym, suitable for passing to |
Static methods¶
-
vncsdk.
enable_add_on
(add_on_code)¶ Enable an SDK add-on by passing in the content of the add-on code, obtained from RealVNC.
For more information, see
vnc_enableAddOn()
.Parameters: add_on_code (str) –
-
vncsdk.
get_build_number
()¶ Returns the runtime build number of the SDK.
For more information, see
vnc_getBuildNumber()
.Return type: int
-
vncsdk.
get_major_version
()¶ Returns the runtime major version number of the SDK.
For more information, see
vnc_getMajorVersion()
.Return type: int
-
vncsdk.
get_minor_version
()¶ Returns the runtime minor version number of the SDK.
For more information, see
vnc_getMinorVersion()
.Return type: int
-
vncsdk.
get_patch_version
()¶ Returns the runtime patch version number of the SDK.
For more information, see
vnc_getPatchVersion()
.Return type: int
-
vncsdk.
keysym_to_unicode
(keysym)¶ Converts a keysym to a unicode - suitable for converting a keysym received on the server in
Server.InputEventsCallbackkeyEventCallback()
.For more information, see
vnc_keysymToUnicode()
.Parameters: keysym (int) – Return type: int
-
vncsdk.
set_cloud_proxy_settings
(system_proxy, proxy_url)¶ Specifies proxy server settings for Cloud connections; note these settings are adopted for all subsequent outgoing Cloud connections.
For more information, see
vnc_setCloudProxySettings()
.Parameters: - system_proxy (bool) –
- proxy_url (str or None) –
-
vncsdk.
shutdown
()¶ Shuts down the SDK, ensuring that any resources are cleared up.
For more information, see
vnc_shutdown()
.
-
vncsdk.
unicode_to_keysym
(unicode_char)¶ Converts a unicode character to a keysym, suitable for passing to
Viewer.send_key_down()
.For more information, see
vnc_unicodeToKeysym()
.Parameters: unicode_char (int) – Return type: int