连接类别 - NICE DCV
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

连接类别

通过调用dcv模块的connect方法获得的连接类。有关说明如何使用它的示例,请参阅 “入门” 部分。

暴露

方法

List

attachDisplay(win,displayConf)→ {Pro <number>|承诺。 < {代码:MultiMonitorErrorCode,消息:字符串} >}

将特定的显示器连接到窗口。您无法连接主显示屏。如果成功,该函数将返回displayId

参数:

名称 类型 描述
win 对象 必须连接显示屏的窗口。
displayConf 对象 显示器的配置。
名称 类型 属性 描述
displayId number <optional> 显示屏的 ID。
displayDivName 显示器 div 的名称。

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

诺言。 <number>| 承诺。 < {code: MultiMonitorErrorCode,消息:string} >

captureClipboardEvents(启用、win、displayId)→ {void}

开始或停止收听复制粘贴事件。对于交互式剪贴板(总是粘贴),我们需要开始监听复制/粘贴事件。只有在需要时才开始和停止监听可能很有用,例如,当显示模态时。

参数:

名称 类型 属性 描述
enabled 布尔值 要开始监听事件,请指定true。要停止监听事件,请指定false
win 对象 <optional> 监听事件的窗口。如果省略,则使用默认窗口。
displayId number <optional> 应该监听事件的显示器的 ID。如果省略,则使用窗口的默认显示方式。

返回值:

类型

void

分离显示屏 (displayID) → {void}

分离特定的显示屏。主显示屏无法分离。

参数:

名称 类型 描述
displayId number 要分离的显示器的 ID。

返回值:

类型

void

断开连接 () → {void}

断开与 NICE DCV 服务器的连接并关闭连接。

返回值:

类型

void

断开连接合作者 (connectionId) → {void}

请求断开与提供的连接 ID 连接的合作者(自 NICE DCV Web Client SDK 版本 1.1.0 起)。

参数:

名称 类型 说明
connectionId 布尔值 将断开的连接的 ID。

返回值:

类型

void

enableDisplayQuality更新(启用)→ {void}

启用或禁用未接收更新的流媒体区域的显示质量更新。禁用显示质量更新会减少带宽使用量,但也会降低显示质量。

参数:

名称 类型 说明
enable 布尔值 要启用显示质量更新,请指定true。要禁用显示质量更新,请指定false

返回值:

类型

void

enableTimezoneRedirection(启用)→ {Promise|Promise。 < {代码:TimezoneRedirectionErrorCode,消息:字符串} >}

启用或禁用时区重定向。启用后,客户端会请求服务器使服务器桌面时区与客户端时区匹配。

参数:

名称 类型 说明
enable 布尔值 要启用时区重定向,请指定true。要禁用时区重定向,请指定false

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

诺言。 <number>| 承诺。 < {code: TimezoneRedirectionErrorCode,消息:string} >

enterRelativeMouse模式 () → {void}

启用相对鼠标模式。

返回值:

类型

void

getConnectedDevices() → {承诺。 <数组。 <MediaDeviceInfo >>|承诺。 < {message: string} >}

请求连接到客户端计算机的媒体设备列表。

返回值:

如果成功,它将返回一个解析为 MediaDeviceInfo 对象数组的 Promise。有关更多信息,请参阅MediaDeviceInfo。https://developer.mozilla.org/en-US/docs/Web/API/ 如果被拒绝,承诺将返回一个错误对象。

类型

诺言。 <数组。 <MediaDeviceInfo >> | 承诺。 < {message: string} >

getFileExplorer() → {承诺。 < 文件存储 >|承诺。 < {代码:ChannelErrorCode,消息:字符串} >}

获取一个用于管理 NICE DCV 服务器文件存储的对象。

返回值:

诺言。如果满足,则解析为文件浏览器对象,如果被拒绝,则解析为错误对象。

类型

诺言。 < 文件存储 > | 承诺。 < {code: ChannelErrorCode,消息:string} >

getServerInfo() → {服务器信息}

获取有关NICE DCV。

返回值:

有关服务器软件的信息。

获取屏幕截图 () → {Promise|Promise。 < {代码:ScreenshotErrorCode,消息:字符串} >}

以 PNG 格式检索远程桌面的屏幕截图。屏幕截图将在 S creenshotCallback 观察器中返回。 null如果出现故障,将改为返回。

返回值:

如果请求得到处理,承诺即会解决。如果被拒绝,我们会收到一个错误对象。

类型

承诺 | 承诺。 < {code: ScreenshotErrorCode,消息:string} >

getStats () → {stats}

获取有关 NICE DCV 服务器的统计信息。

返回值:

有关流媒体统计信息的信息。

类型

统计数据

latchModifierKey(密钥、位置、isDown)→ {boolean}

为允许的修饰符发送单个键盘keydownkeyup事件。

参数:

名称 类型 描述
key 控制 | Alt | AltGraph | Meta | OS | Shift 要发送的密钥。
location KeyboardEvent. 位置 钥匙的位置。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/
isDown 布尔值 如果要注入的按键事件是 keydown (true) 或 keyup (false)。

返回值:

如果请求的组合有效,该函数将返回true返回值false

类型

布尔值

OpenChannel(名称、authToken、回调、命名空间)→ {Promise|Promise。 < {代码:ChannelErrorCode,消息:字符串} >}

如果自定义数据通道是在 NICE DCV 服务器上创建的,则在连接上打开该通道。

参数:

名称 类型 描述
name 字符串 通道的名称。
authToken 字符串 用于连接频道的身份验证令牌。
callbacks 对象 要调用的 onMessage 和 onClose 回调函数。
namespace 字符串 通道的命名空间。自 NICE DCV Web Client SDK 1.2.0 和 NICE DCV Server 2022.1 起上线。

返回值:

诺言。如果被拒绝,我们会收到一个错误对象。

类型

承诺 | 承诺。 < {code: ChannelErrorCode,消息:string} >

查询功能(功能名称)→ {Promise。 < {启用:布尔值,远程? : 字符串,自动复制? : 布尔值,自动粘贴? : 布尔值,服务状态? : 字符串,可用吗? : 布尔值} >|Promise。 < {message: string} >}

查询特定 NICE DCV 服务器功能的状态。

参数:

名称 类型 描述
featureName 功能 要查询的功能名称。

返回值:

诺言。如果得到解决,该函数将返回一个status对象,该对象始终包含一个enabled属性,可能还包含其他属性。如果被拒绝,该函数将返回一个error对象。

类型

{承诺。 < {启用:布尔值,远程? : 字符串,自动复制? : 布尔值,自动粘贴? : 布尔值,服务状态? : 字符串,可用吗? : 布尔值} > | 承诺。 < {message: string} >

registerKeyboardShortcuts(快捷方式)→ {void}

注册键盘快捷键。

参数:

名称 类型 描述
shortcuts 数组。 <Object> 要注册的键和映射数组。
名称 类型 描述
sequence 数组。 <Object> 注册的键盘快捷键。
名称 类型 描述
key KeyboardEvent.key 用户按下的按键的值。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/
location KeyboardEvent. 位置 要发送的密钥数组。键盘上密钥的位置。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/
output 数组。 <Object> 快捷方式要执行的预期操作。
名称 类型 描述
key KeyboardEvent.key 用户按下的按键的值。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/
location KeyboardEvent. 位置 要发送的密钥数组。键盘上密钥的位置。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/

返回值:

类型

void

requestDisplayConfig(highColorAccuracy) → {Promise|Promise。 < {代码:DisplayConfigErrorCode,消息:字符串} >}

从 NICE DCV 服务器请求更新的显示配置。自 NICE DCV Web Client SDK 1.1.0 和 NICE DCV Server 2022.0 起上市。

参数:

名称 类型 说明
highColorAccuracy 布尔值 是否应要求高色彩精度。

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

承诺 | 承诺。 < {code: DisplayConfigErrorCode,消息:string} >

requestDisplayLayout(布局)→ {Promise|Promise。 < {代码:ResolutionErrorCode,消息:字符串} >}

请求更新连接的显示布局。

参数:

名称 类型 描述
layout 数组。 < 监视器 > 请求的内容显示在布局中。

返回值:

诺言。如果被拒绝,我们会收到一个错误对象。

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:string} >

请求分辨率(宽度、高度)→ {Promise|Promise。 < {代码:ResolutionErrorCode,消息:字符串} >}

向 NICE DCV 服务器请求更新的显示分辨率。

参数:

名称 类型 描述
width number 请求的宽度,以像素为单位。允许的最小值为0
height number 请求的高度(以像素为单位)。允许的最小值为0

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:string} >

sendKeyboardEvent(事件)→ {布尔值}

发送键盘快捷键事件。有关键盘事件的更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent。有效的键盘事件包括:keydownkeypress、和keyup。有关这些活动的更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent #events

参数:

名称 类型 描述
event KeyboardEvent 要发送的键盘事件。

返回值:

如果事件无效,则函数返回false。如果事件有效,该函数将返回结果true

类型

布尔值

sendKeyboardShortcut(快捷方式)→ {void}

发送键盘快捷键。使用此函数发送完整keydownkeyup序列。例如,发送 Ctrl + Alt + Del 会先发送所有按键keyup的事件,然后发送事件。keydown即使您想发送单个密钥,也可以使用此功能。

参数:

名称 类型 描述
shortcut 数组。 <Object> 要发送的密钥数组。
名称 类型 描述
key KeyboardEvent.key 用户按下的按键的值。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/
location KeyboardEvent. 位置 要发送的密钥数组。键盘上密钥的位置。有关更多信息,请参KeyboardEvent阅。https://developer.mozilla.org/en-US/docs/Web/API/

返回值:

类型

void

setDisplayQuality(min,maxopt)→ {void}

设置用于连接的图像质量。有效范围01100,图像质量最低100,图像质量最高。指定0保留当前值。

参数:

名称 类型 属性 描述
min number 最低图像质量。
max number <optional> 最大图像质量。

返回值:

类型

void

setDisplayScale(scaleRatio,displayID)→ {Promise|Promise。 < {code: ResolutionErrorCode,消息:string} >}(已过时)

自 1.3.0 版起已不推荐使用。无需再设置显示比例。鼠标坐标将在内部自动管理。

通知 NICE DCV 客户端显示屏已缩放。使用它来通知服务器它需要缩放鼠标事件以匹配客户端的显示比例。

参数:

名称 类型 描述
scaleRatio float 要使用的缩放比例。必须是严格的正数。
displayId number 要缩放的显示屏的 ID。

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:string} >

setKeyboardQuirks(怪癖)→ {void}

为客户端计算机设置键盘怪癖。

参数:

名称 类型 描述
quirks 对象 键盘奇怪的启用或禁用。
名称 类型 说明
macOptionToAlt 布尔值 要在 macOS 上将 Option 键映射到 Alt,请指定true。否则,请指定 false
macCommandToControl 布尔值 要将命令键映射到 macOS 版 Ctrl,请指定true。否则,请指定 false

返回值:

类型

void

setMaxDisplay分辨率(最大宽度、最大高度)→ {void}

设置用于连接的最大显示分辨率。

参数:

名称 类型 描述
maxWidth number 最大显示宽度(以像素为单位)。允许的最小值为0
maxHeight number 最大显示高度(以像素为单位)。允许的最小值为0

返回值:

类型

void

设置麦克风(启用)→ {Promise|Promise。 < {代码:AudioErrorCode,消息:字符串} >}

启用或禁用麦克风。

参数:

名称 类型 说明
enable 布尔值 要启用麦克风,请指定true。要禁用麦克风,请指定false

返回值:

诺言。如果被拒绝,承诺将返回一个错误对象。

类型

承诺 | 承诺。 < {code: AudioErrorCode,消息:string} >

setMinDisplay分辨率(最小宽度、最小高度)→ {void}

设置用于连接的最小显示分辨率。某些应用程序可能需要最低显示分辨率。如果所需的最小分辨率大于客户端支持的最大分辨率,则使用调整大小策略。请谨慎使用此功能。调整大小策略可能会导致鼠标和触摸输入系统的精度降低。

参数:

名称 类型 描述
minWidth number 最小显示宽度(以像素为单位)。允许的最小值为0
minHeight number 以像素为单位的最小显示高度。允许的最小值为0

返回值:

类型

void

setUploadBandwidth(值)→ {数字}

设置用于将文件上传到 NICE DCV 服务器的最大带宽。

参数:

名称 类型 描述
value number 最大带宽限制,以 kbps 为单位。有效范围为 1024 kbps 到 102400 kbps。

返回值:

-设置的带宽限制。 null如果服务器上禁用了文件存储功能。

类型

number

设置音量(音量)→ {void}

设置用于音频的音量。有效范围为 0 到 100,其中 0 是最低音量,100 是最高音量。

参数:

名称 类型 描述
volume number 要使用的音量。

返回值:

类型

void

setWebCam(启用,deviceID)→ {Promise|Promise。 < {代码:WebcamErrorCode,消息:字符串} >}

启用或禁用摄像头。

参数:

名称 类型 说明
enable 布尔值 要启用摄像头,请指定true。要禁用摄像头,请指定false
deviceId 字符串 网络摄像头的设备 ID。

返回值:

承诺,如果成功,将解析为连接/分离的网络摄像头 deviceID。如果被拒绝,承诺将返回一个错误对象。

类型

承诺 | 承诺。 < {code: WebcamErrorCode,消息:string} >

SyncClipBoards () → {boolean}

将本地客户端剪贴板与远程 NICE DCV 服务器剪贴板同步。浏览器必须支持自动复制。

返回值:

如果剪贴板已同步,则该函数返回true。如果剪贴板尚未同步,或者浏览器不支持自动复制,则该函数返回false

类型

布尔值