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

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

连接类

通过调用connect方法dcv模块。有关展示如何使用它的示例,请参阅入门部分。

Expise

方法

列表

附上显示(赢,DisplayConf)→ {承诺。 <number>| 承诺。 < {代码: MultiMonitorErrorCode,消息:字符串} >}

将特定的显示器附加到窗口。你不能连接主显示器。如果成功,该函数会返回displayId.

参数:

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

返回值:

承诺。如果拒绝,承诺会返回错误对象。

类型

承诺。 <number>| 承诺。 < {代码: MultiMonitorErrorCode,消息:string} >

captureClipboardEvents(已启用、赢、DisplayId)→ {void}

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

参数:

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

返回值:

类型

void

分离显示 (DisplayID) → {void}

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

参数:

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

返回值:

类型

void

断开 () → {void}

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

返回值:

类型

void

断开协作者(ConnecconnectionId)→ {void}

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

参数:

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

返回值:

类型

void

enableDisplayQuality更新(启用)→ {void}

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

参数:

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

返回值:

类型

void

enterRelativeMouse模式 () → {void}

启用相对鼠标模式。

返回值:

类型

void

getConnectedDevices() → {承诺。 < 阵列。 <MediaDevice信息 >>| 承诺。 < {message: string} >}

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

返回值:

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

类型

承诺。 < 阵列。 <MediaDevice信息 >> | 承诺。 < {message: string} >

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

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

返回值:

承诺。如果已完成,则解析文件资源管理器对象;如果拒绝,则解析错误对象。

类型

承诺。 <文件存储> | 承诺。 < {代码: ChannelError代码,消息:string} >

getServerInfo() → {ServerInfo}

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

返回值:

有关服务器软件的信息。

类型

ServerInfo

getStats () → {统计数据}

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

返回值:

有关流统计数据的信息。

类型

统计数据

latchModifierKey(键、位置、iSDOWN)→ {布尔值}

发送单个键盘keydown要么keyup允许的修饰符的事件。

参数:

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

返回值:

如果请求的组合有效,该函数返回。true,否则它会返回false.

类型

布尔值

OpenChannel(姓名、AuthToken、回调)→ {Promise| 承诺。 < {代码: ChannelError代码,消息:字符串} >}

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

参数:

名称 类型 说明
name 字符串 通道的名称。
authToken 字符串 用于连接频道的身份验证令牌。
callbacks 对象 onMessage 和 onClose 回调函数要调用。

返回值:

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

类型

承诺 | 承诺。 < {代码: ChannelError代码,消息:string} >

查询功能(功能重命名)→ {Promise。 < {启用:布尔值,远程? : 字符串,自动复制? :布尔值,自动粘贴? :布尔值,ServiceStatus? :字符串,可用? : 布尔值} >| 承诺。 < {message: string} >}

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

参数:

名称 类型 说明
featureName 功能 要查询的要素的名称。

返回值:

承诺。如果解决,该函数会返回status始终包含enabled财产,可能还有其他财产。如果拒绝,该函数会返回error对象。

类型

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

registerKeyboardShortcuts(快捷键)→ {void}

注册键盘快捷键。

参数:

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

返回值:

类型

void

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

从 NICE DCV 服务器请求更新的显示配置。自 NICE DCV Web 客户端 SDK 1.1.0 和 NICE DCV 服务器 2022.0 以来可用。

参数:

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

返回值:

承诺。如果拒绝,承诺会返回错误对象。

类型

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

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

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

参数:

名称 类型 说明
layout 数组。 <显示器> 请求的布局将显示在布局中。

返回值:

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

类型

承诺 | 承诺。 < {代码: ResolutionError代码,消息:string} >

请求解决方案 (宽度、高度) → {Promise | Promise。 < {代码: ResolutionError代码,消息:字符串} >}

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

参数:

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

返回值:

承诺。如果拒绝,承诺会返回错误对象。

类型

承诺 | 承诺。 < {代码: ResolutionError代码,消息: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}

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

参数:

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

返回值:

类型

void

setDisplayQuality(min,maxopt)→ {void}

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

参数:

名称 类型 属性 说明
min number 最低图像质量。
max number <optional> 最高图像质量。

返回值:

类型

void

setDisplayScale(缩放比率,DisplayId)→ {Promise| 承诺。 < {代码: ResolutionError代码,消息:字符串} >}

通知 NICE DCV 显示屏在客户端缩放。使用此功能可以通知服务器它需要缩放鼠标事件以匹配客户端的显示比率。

参数:

名称 类型 说明
scaleRatio float 要使用的缩放比率。必须是严格的正数。
displayId number 要缩放的显示器的 ID。

返回值:

承诺。如果拒绝,承诺会返回错误对象。

类型

承诺 | 承诺。 < {代码: ResolutionError代码,消息:string} >

setKeyboardQuirks(怪癖)→ {void}

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

参数:

名称 类型 说明
quirks 对象 要启用或禁用的键盘怪癖。
名称 类型 说明
macOptionToAlt 布尔值 要将 Option 键映射到 macOS 的 Alt 键,请指定true. 否则,请指定 false
macCommandToControl 布尔值 要将 Command 键映射到 Ctrl,请指定true. 否则,请指定 false

返回值:

类型

void

setMaxDisplay分辨率(maxWidth,maxHigh)→ {void}

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

参数:

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

返回值:

类型

void

Set 麦克风(启用)→ {Promise| 承诺。 < {代码: AudioError代码,消息:字符串} >}

启用或禁用麦克风。

参数:

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

返回值:

承诺。如果拒绝,承诺会返回错误对象。

类型

承诺 | 承诺。 < {代码: AudioError代码,消息:string} >

setMinDisplay分辨率(minWidth、minHeight)→ {void}

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

参数:

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

返回值:

类型

void

setUploadBandwidth(值)→ {数字}

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

参数:

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

返回值:

-设定的带宽限制。null是否在服务器上禁用了文件存储功能。

类型

number

setVolume(卷)→ {void}

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

参数:

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

返回值:

类型

void

setWebcam(启用,设备 ID)→ {Promise| 承诺。 < {代码: WebcamError代码,消息:字符串} >}

启用或禁用网络摄像头。

参数:

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

返回值:

承诺,如果成功,将解析为已连接/分离的网络摄像头设备 Id。如果拒绝,承诺会返回错误对象。

类型

承诺 | 承诺。 < {代码: WebcamError代码,消息:string} >

syncClipBoards () → {布尔值}

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

返回值:

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

类型

布尔值