本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Connection 类
调用 dcv
模块的 connect 方法获取的 Connection 类。有关说明如何使用该类的示例,请参阅入门一节。
公开
方法
List
- attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>}
- captureClipboardEvents(enabled, win, displayId) → {void}
- detachDisplay(displayId) → {void}
- disconnect() → {void}
- disconnectCollaborator(connectionId) → {void}
- enableDisplayQualityUpdates(enable) → {void}
- enableTimezoneRedirection(enable) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>}
- enterRelativeMouseMode() → {void}
- getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>|Promise.<{message: string}>}
- getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>}
- getServerInfo() → {serverInfo}
- getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}
- getStats() → {stats}
- latchModifierKey(key, location, isDown) → {boolean}
- openChannel(name, authToken, callbacks, namespace) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>}
- queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}
- registerKeyboardShortcuts(shortcuts) → {void}
- requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>}
- requestDisplayLayout(layout) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
- requestResolution(width, height) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
- sendKeyboardEvent(event) → {boolean}
- sendKeyboardShortcut(shortcut) → {void}
- setDisplayQuality(min, maxopt) → {void}
- setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED)
- setKeyboardQuirks(quirks) → {void}
- setMaxDisplayResolution(maxWidth, maxHeight) → {void}
- setMicrophone(enable) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
- setMinDisplayResolution(minWidth, minHeight) → {void}
- setUploadBandwidth(value) → {number}
- setVolume(volume) → {void}
- setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}
- syncClipboards() → {boolean}
attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>}
将特定的显示器连接到窗口。您无法连接主显示器。如果成功,该函数返回 displayId
。
参数:
名称 | 类型 | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
win
|
对象 | 必须将显示器连接到的窗口。 | ||||||||||||
displayConf
|
对象 | 显示器的配置。
|
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise.<number> | Promise.<{code: MultiMonitorErrorCode, message: string}>
captureClipboardEvents(enabled, win, displayId) → {void}
开始或停止侦听复制粘贴事件。对于交互式剪贴板(对于粘贴,始终如此),我们需要开始侦听复制/粘贴事件。仅在需要时(例如,在显示模式时)开始和停止侦听可能是非常有用的。
参数:
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
enabled
|
布尔值 | 要开始侦听事件,请指定 true 。要停止侦听事件,请指定 false 。 |
|
win
|
对象 | <可选> | 在其中侦听事件的窗口。如果省略,则使用默认窗口。 |
displayId
|
number | <可选> | 应侦听事件的显示器的 ID。如果省略,则使用窗口的默认显示器。 |
返回值:
- 类型
-
void
detachDisplay(displayId) → {void}
断开连接特定的显示器。无法断开连接主显示器。
参数:
名称 | 类型 | 描述 |
---|---|---|
displayId
|
number | 要断开连接的显示器的 ID。 |
返回值:
- 类型
-
void
disconnect() → {void}
与 NICE DCV 服务器断开连接并关闭连接。
返回值:
- 类型
-
void
disconnectCollaborator(connectionId) → {void}
请求断开与提供的连接 ID 相连的协作者(自 NICE DCV Web Client SDK 版本 1.1.0 起)。
参数:
名称 | 类型 | 说明 |
---|---|---|
connectionId
|
布尔值 | 将断开的连接的 ID。 |
返回值:
- 类型
-
void
enableDisplayQualityUpdates(enable) → {void}
为不接收更新的流区域启用或禁用显示质量更新。禁用显示质量更新将减少带宽使用量,但也会降低显示质量。
参数:
名称 | 类型 | 说明 |
---|---|---|
enable
|
布尔值 | 要启用显示质量更新,请指定 true 。要禁用显示质量更新,请指定 false 。 |
返回值:
- 类型
-
void
enableTimezoneRedirection(enable) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>}
启用或禁用时区重定向。在启用后,客户端请求服务器将服务器桌面时区与客户端时区匹配。
参数:
名称 | 类型 | 说明 |
---|---|---|
enable
|
布尔值 | 要启用时区重定向,请指定 true 。要禁用时区重定向,请指定 false 。 |
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise.<number> | Promise.<{code: TimezoneRedirectionErrorCode, message: string}>
enterRelativeMouseMode() → {void}
启用相对鼠标模式。
返回值:
- 类型
-
void
getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>|Promise.<{message: string}>}
请求连接到客户端计算机的媒体设备的列表。
返回值:
如果成功,它返回一个解析为 MediaDeviceInfo 对象数组的 Promise。有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise.<Array.<MediaDeviceInfo>> | Promise.<{message: string}>
getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>}
获取一个对象以管理 NICE DCV 服务器的文件存储。
返回值:
Promise。如果完成,则解析为文件资源管理器对象;如果被拒绝,则解析为错误对象。
- 类型
-
Promise.<filestorage> | Promise.<{code: ChannelErrorCode, message: string}>
getServerInfo() → {serverInfo}
获取有关 NICE DCV 服务器的信息。
返回值:
有关服务器软件的信息。
- 类型
getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}
检索 PNG 格式的远程桌面屏幕截图。屏幕截图将在 screenshotCallback 观察者中返回。如果失败,将返回 null
。
返回值:
在处理了请求时解析的 Promise。如果被拒绝,我们将收到一个错误对象。
- 类型
-
Promise | Promise.<{code: ScreenshotErrorCode, message: string}>
getStats() → {stats}
获取有关 NICE DCV 服务器的统计信息。
返回值:
有关流式传输统计信息的信息。
- 类型
latchModifierKey(key, location, isDown) → {boolean}
为允许的修饰键发送单个键盘 keydown
或 keyup
事件。
参数:
名称 | 类型 | 描述 |
---|---|---|
key
|
Control | Alt | AltGraph | Meta | OS | Shift | 要发送的键。 |
location
|
KeyboardEvent.location | 键的位置。有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 |
isDown
|
布尔值 | 如果要注入的按键事件是 keydown (true ) 或 keyup (false )。 |
返回值:
如果请求的组合有效,该函数返回 true
,否则,该函数返回 false
。
- 类型
-
布尔值
openChannel(name, authToken, callbacks, namespace) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>}
如果在 NICE DCV 服务器上创建了连接,则在该连接上打开自定义数据通道。
参数:
名称 | 类型 | 描述 |
---|---|---|
name
|
字符串 | 通道的名称。 |
authToken
|
字符串 | 用于连接到通道的身份验证令牌。 |
callbacks
|
对象 | 要调用的 onMessage 和 onClose 回调函数。 |
namespace
|
字符串 | 通道的命名空间。自 NICE DCV Web Client SDK 1.2.0 和 NICE DCV Server 2022.1 起提供。 |
返回值:
Promise。如果被拒绝,我们将收到一个错误对象。
- 类型
-
Promise | Promise.<{code: ChannelErrorCode, message: string}>
queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}
查询特定 NICE DCV 服务器功能的状态。
参数:
名称 | 类型 | 描述 |
---|---|---|
featureName
|
feature | 要查询的功能的名称。 |
返回值:
Promise。如果已解析,该函数返回一个 status
对象,该对象始终包含 enabled
属性,并且还可能包含其他属性。如果被拒绝,该函数返回一个 error
对象。
- 类型
-
{Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> | Promise.<{message: string}>
registerKeyboardShortcuts(shortcuts) → {void}
注册键盘快捷键。
参数:
名称 | 类型 | 描述 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shortcuts
|
Array.<Object> | 要注册的键和映射的数组。
|
返回值:
- 类型
-
void
requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>}
从 NICE DCV 服务器中请求更新的显示配置。自 NICE DCV Web Client SDK 1.1.0 和 NICE DCV Server 2022.0 起提供。
参数:
名称 | 类型 | 说明 |
---|---|---|
highColorAccuracy
|
布尔值 | 是否应请求高色彩精度。 |
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise | Promise.<{code: DisplayConfigErrorCode, message: string}>
requestDisplayLayout(layout) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
为连接请求更新的显示布局。
参数:
名称 | 类型 | 描述 |
---|---|---|
layout
|
Array.<Monitor> | 请求的内容显示在布局中。 |
返回值:
Promise。如果被拒绝,我们将收到一个错误对象。
- 类型
-
Promise | Promise.<{code: ResolutionErrorCode, message: string}>
requestResolution(width, height) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
从 NICE DCV 服务器中请求更新的显示分辨率。
参数:
名称 | 类型 | 描述 |
---|---|---|
width
|
number | 请求的宽度(以像素为单位)。最小的允许值为 0 。 |
height
|
number | 请求的高度(以像素为单位)。最小的允许值为 0 。 |
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise | Promise.<{code: ResolutionErrorCode, message: string}>
sendKeyboardEvent(event) → {boolean}
发送键盘快捷键事件。有关键盘事件的更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEventkeydown
、keypress
和 keyup
。有关这些事件的更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events
参数:
名称 | 类型 | 描述 |
---|---|---|
event
|
KeyboardEvent | 要发送的键盘事件。 |
返回值:
如果事件无效,该函数返回 false
。如果事件有效,该函数返回 true
。
- 类型
-
布尔值
sendKeyboardShortcut(shortcut) → {void}
发送键盘快捷键。可以使用该函数发送完整 keydown
或 keyup
序列。例如,在发送 Ctrl + Alt + Del 时,将发送所有按键的 keydown
事件,然后发送 keyup
事件。即使您希望发送单个键,也可以使用该函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
shortcut
|
Array.<Object> | 要发送的键的数组。
|
返回值:
- 类型
-
void
setDisplayQuality(min, maxopt) → {void}
设置用于连接的图像质量。有效范围是 0
到 100
,其中 1
为最低图像质量,100
为最高图像质量。指定 0
将保留当前值。
参数:
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
min
|
number | 最低图像质量。 | |
max
|
number | <可选> | 最高图像质量。 |
返回值:
- 类型
-
void
setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED)
自版本 1.3.0 起已弃用。无需再设置显示比例。将在内部自动管理鼠标坐标。
通知 NICE DCV 在客户端缩放了显示比例。可以使用该函数通知服务器,需要缩放鼠标事件以与客户端的显示比率匹配。
参数:
名称 | 类型 | 描述 |
---|---|---|
scaleRatio
|
float | 要使用的缩放比率。必须是严格的正数。 |
displayId
|
number | 要缩放的显示器的 ID。 |
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise | Promise.<{code: ResolutionErrorCode, message: string}>
setKeyboardQuirks(quirks) → {void}
设置客户端计算机的键盘特性。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
quirks
|
对象 | 要启用或禁用的键盘特性。
|
返回值:
- 类型
-
void
setMaxDisplayResolution(maxWidth, maxHeight) → {void}
设置用于连接的最大显示分辨率。
参数:
名称 | 类型 | 描述 |
---|---|---|
maxWidth
|
number | 最大显示宽度(以像素为单位)。最小的允许值为 0 。 |
maxHeight
|
number | 最大显示高度(以像素为单位)。最小的允许值为 0 。 |
返回值:
- 类型
-
void
setMicrophone(enable) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
启用或禁用麦克风。
参数:
名称 | 类型 | 说明 |
---|---|---|
enable
|
布尔值 | 要启用麦克风,请指定 true 。要禁用麦克风,请指定 false 。 |
返回值:
Promise。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise | Promise.<{code: AudioErrorCode, message: string}>
setMinDisplayResolution(minWidth, minHeight) → {void}
设置用于连接的最小显示分辨率。某些应用程序可能需要使用最低显示分辨率。如果所需的最小分辨率大于客户端支持的最大分辨率,则使用调整大小策略。请谨慎使用该函数。调整大小策略可能会导致鼠标和触摸输入系统的精度下降。
参数:
名称 | 类型 | 描述 |
---|---|---|
minWidth
|
number | 最小显示宽度(以像素为单位)。最小的允许值为 0 。 |
minHeight
|
number | 最小显示高度(以像素为单位)。最小的允许值为 0 。 |
返回值:
- 类型
-
void
setUploadBandwidth(value) → {number}
设置用于将文件上传到 NICE DCV 服务器的最大带宽。
参数:
名称 | 类型 | 描述 |
---|---|---|
value
|
number | 最大带宽限制(以 kbps 为单位)。有效范围是 1024 kbps 到 102400 kbps。 |
返回值:
- 设置的带宽限制。如果在服务器上禁用了文件存储功能,则为 null
。
- 类型
-
number
setVolume(volume) → {void}
设置用于音频的音量。有效范围是 0 到 100,其中 0 为最低音量,100 为最高音量。
参数:
名称 | 类型 | 描述 |
---|---|---|
volume
|
number | 要使用的音量。 |
返回值:
- 类型
-
void
setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}
启用或禁用网络摄像头。
参数:
名称 | 类型 | 说明 |
---|---|---|
enable
|
布尔值 | 要启用网络摄像头,请指定 true 。要禁用网络摄像头,请指定 false 。 |
deviceId
|
字符串 | 网络摄像头的设备 ID。 |
返回值:
Promise,如果成功,将解析为连接/断开连接的网络摄像头的 deviceId。如果被拒绝,Promise 返回一个错误对象。
- 类型
-
Promise | Promise.<{code: WebcamErrorCode, message: string}>
syncClipboards() → {boolean}
将本地客户端剪贴板与远程 NICE DCV 服务器剪贴板同步。浏览器必须支持自动复制。
返回值:
如果剪贴板已同步,该函数返回 true
。如果剪贴板尚未同步,或者浏览器不支持自动复制,该函数返回 false
。
- 类型
-
布尔值