novnc文档。。。

2,646 阅读2分钟

RFB

RFB对象代表与VNC服务器的单个连接。 它使用必须提供标准RFB协议流的WebSocket进行通信。

Constructor

创建并返回一个新的rfb对象。

属性

viewOnly

是一个布尔值。禁止向服务器发送任何鼠标和键盘事件,也就是只能渲染界面,不能操作。 默认值false。

focusOnClick

是一个布尔值。在收到mousedown或touchstart事件时是否应将键盘焦点自动移至远程会话。 默认值true。

touchButton

是一个数字类型。 和长按事件类似。 使用与MouseEvent.button相同的值。 默认设置为1。

clipViewport

是一个布尔值。 是否应将远程会话剪切到其容器。 禁用后,将显示滚动条来处理由此产生的溢出。 默认false。

dragViewport

一个布尔值。鼠标事件是否应控制剪切的远程会话的相对位置。 仅在clipViewport为true时可用。 默认false。

scaleViewport

一个布尔值。是否应在本地缩放远程会话以使其适合其容器。 禁用后,如果远程会话小于其容器,它将居中;如果远程会话大于容器,则根据clipViewport处理。 默认false。

resizeSession

是一个布尔值。每当容器更改尺寸时是否应发送调整远程会话大小的请求。 默认false。

showDotCursor

是一个布尔值。如果服务器设置了不可见的游标,则应显示点游标而不是零大小或完全透明的游标。 默认false。

background

是有效的CSS背景样式值,为远程桌面提供一个初始化的背景色。 默认值为rgb(40,40,40)(纯灰色)。

capabilities Read only

是一个对象,服务器上可用的可选扩展。 如果设置了相应的功能,则只能调用某些方法。 定义了以下功能:

name type descrption
power boolean Machine power control is available

事件

connect

当RFB对象完成与服务器的连接和握手时,将触发connect事件。

disconnect

当RFB对象与服务器断开连接时,触发。

credentialsrequired

当必须提供更多凭据才能继续时,将触发凭据要求事件。

securityfailure

与服务器的安全协商失败时触发。

clipboard

从服务器接收到剪贴板数据时触发。

bell

从服务器收到可听见的响铃请求时触发

desktopname

远程桌面名称修改时触发。

capabilities

RFB.capabilities 被更新时触发

方法

RFB.disconnect()

断开连接

RFB.sendCredentials()

发送给服务器认证信息。 在触发凭据要求事件后应调用此方法。

RFB.sendKey()

发送键盘事件

RFB.sendCtrlAltDel()

发送ctrl-alt-del 快捷键事件。

RFB.focus()

聚焦事件

RFB.blur()

失焦

RFB.machineShutdown()

关机

RFB.machineReboot()

重启

RFB.machineReset()

重置计算机

RFB.clipboardPasteFrom()

将剪贴板内容发送到服务器。