Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

CloudConnector

vncsdk.CloudConnector

Connector used to join VNC Cloud and establish an outgoing connection.

Constructor Summary

Modifier and Type Method and Description

CloudConnector(localCloudAddress, localCloudPassword)

Creates a connector, which is used used to create connections to Cloud addresses.

Method Summary

Modifier and Type Method and Description

connect(peerCloudAddress, connectionHandler)

Begins an outgoing connection to the given Cloud address.

destroy()

Destroys the Cloud connector.

setRelayBandwidthLimit(relayBandwidthLimit)

Set the bandwidth limit applied to relayed Cloud connections.

setWaitForPeer(waitForPeer)

Sets whether new connections created by the connector wait for the peer to start listening.

Constructor

class vncsdk.CloudConnector(localCloudAddress, localCloudPassword)

Creates a connector, which is used used to create connections to Cloud addresses.

For more information, see vnc_CloudConnector_create().

Arguments:
  • localCloudAddress (string) –
  • localCloudPassword (string) –
Throws:

vncsdk.VncException on error

Methods

CloudConnector.connect(peerCloudAddress, connectionHandler)

Begins an outgoing connection to the given Cloud address.

For more information, see vnc_CloudConnector_connect().

Arguments:
Throws:

vncsdk.VncException on error
CloudConnector.destroy()

Destroys the Cloud connector.

For more information, see vnc_CloudConnector_destroy().

CloudConnector.setRelayBandwidthLimit(relayBandwidthLimit)

Set the bandwidth limit applied to relayed Cloud connections.

For more information, see vnc_CloudConnector_setRelayBandwidthLimit().

Arguments:
  • relayBandwidthLimit (number) –
Throws:

vncsdk.VncException on error
CloudConnector.setWaitForPeer(waitForPeer)

Sets whether new connections created by the connector wait for the peer to start listening.

For more information, see vnc_CloudConnector_setWaitForPeer().

Arguments:
  • waitForPeer (boolean) –
×