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

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

连接类

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

Exmise

Methods

List

附件显示(窗口,显示会议)→ {承诺。 <number>| 承诺。 < {代码: MultiMonitorErrorCode,消息:字符串} >}

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

参数:

名称 类型 描述
window Object 显示屏必须附加到的窗口。
displayConf Object 显示器的配置。
名称 类型 Attributes 描述
displayId number <optional> 显示器的 ID。
displayDivName 显示 div 的名称。

返回值:

承诺 如果拒绝,则 promise 返回一个错误对象。

类型

承诺 <number>| 承诺。 < {代码: 多监视器代码,消息:字符串} >

捕获板分配(启用、赢取、显示 ID)→ {void}

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

参数:

名称 类型 Attributes 描述
enabled 布尔值 要开始侦听事件,请指定true。要停止侦听事件,请指定false
win Object <optional> 侦听事件的窗口。如果忽略,则将使用默认窗口。
displayId number <optional> 应监听事件的显示器的 ID。如果忽略,则将使用窗口的默认显示。

返回值:

类型

void

分离显示(显示 ID)→ {void}

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

参数:

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

返回值:

类型

void

断开连接 () → {void}

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

返回值:

类型

void

启用显示质量更新(启用)→ {void}

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

参数:

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

返回值:

类型

void

娱乐相关鼠标模式 () → {void}

启用相对鼠标模式。

返回值:

类型

void

获取已连接的设备 () → {承诺。 < 数组。 <MediaDeviceInfo>>> | 承诺。 < {message: string} >}

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

返回值:

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

类型

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

获取文件资源管理器 () → {承诺。 <filestorage>| 承诺。 < {代码: ChannelErrorCode,消息:字符串} >}

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

返回值:

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

类型

承诺 <文件存储> | 承诺。 < {代码: 通道错误代码,消息:字符串} >

获取服务器信息 () → {serverInfo}

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

返回值:

有关服务器软件的信息。

得到统计数据 () → {stats}

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

返回值:

有关流统计数据的信息。

类型

stats

锁存器修饰键(键,位置,ISDown)→ {布尔值}

发送单个键盘keydown或者keyup事件,以获取允许的修饰符。

参数:

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

返回值:

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

类型

布尔值

开放通道(名称、授权令牌、回调)→ {承诺 | 承诺。 < {代码: ChannelErrorCode,消息:字符串} >}

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

参数:

名称 类型 描述
name 字符串 通道的名称。
authToken 字符串 用于连接到频道的身份验证令牌。
callbacks Object 要调用的 On 消息和 OnClose 回调函数。

返回值:

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

类型

承诺 | 承诺。 < {代码: 通道错误代码,消息:字符串} >

查询功能(功能重命名)→ {承诺。 < {enabled: boolean} >| 承诺。 < {message: string} >}

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

参数:

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

返回值:

承诺 如果解决,该函数会返回一个status对象使用enabled属性。如果拒绝,该函数会返回一个error对象。

类型

承诺 < {enabled: boolean} >| 承诺。 < {message: string} >

注册键盘快捷键(快捷方式)→ {void}

注册键盘快捷键。

参数:

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

返回值:

类型

void

请求显示布局(布局)→ {承诺 | 承诺。 < {代码: ResolutionErrorCode,消息:字符串} >}

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

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {代码: 解决方案错误代码,消息:字符串} >

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

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

参数:

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

返回值:

承诺 如果拒绝,则 promise 返回一个错误对象。

类型

承诺 | 承诺。 < {代码: 解决方案错误代码,消息:字符串} >

发送键盘发展(事件)→ {布尔值}

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

参数:

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

返回值:

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

类型

布尔值

发送键盘快捷方式(快捷方式)→ {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 键盘。位置 要发送的键数组。键盘上键的位置。有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。

返回值:

类型

void

设置显示质量(最小值,最大值)→ {void}

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

参数:

名称 类型 Attributes 描述
min number 最低图像质量。
max number <optional> 最高图像质量。

返回值:

类型

void

设置显示规模(缩放映射,显示 ID)→ {承诺 | 承诺。 < {代码: ResolutionErrorCode,消息:字符串} >}

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

参数:

名称 类型 描述
scaleRatio float 要使用的缩放率 (允许范围)(0,1])。
displayId number 要缩放的显示的 ID。

返回值:

承诺 如果拒绝,则 promise 返回一个错误对象。

类型

承诺 | 承诺。 < {代码: 解决方案错误代码,消息:字符串} >

设置键盘怪癖(怪癖)→ {void}

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

参数:

名称 类型 描述
quirks Object 键盘怪癖启用或禁用。
名称 类型 描述
macOptionToAlt 布尔值 要将选项键映射到适用于 macOS 的 Alt,请指定true。否则,请指定 false
macCommandToControl 布尔值 要将 Command 键映射到 macOS 的 Ctrl,请指定true。否则,请指定 false

返回值:

类型

void

设置最大显示分辨率(最大宽度,最大高度)→ {void}

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

参数:

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

返回值:

类型

void

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

启用或禁用麦克风。

参数:

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

返回值:

承诺 如果拒绝,则 promise 返回一个错误对象。

类型

承诺 | 承诺。 < {代码: 音频错误代码,消息:字符串} >

设置显示分辨率(最小宽度,最小高度)→ {void}

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

参数:

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

返回值:

类型

void

设置带宽(值)→ {數字}

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

参数:

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

返回值:

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

类型

number

设置卷(卷)→ {无效}

设置用于音频的音量级别。有效范围为 0 到 100,0 表示最低音量,100 表示最高音量。

参数:

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

返回值:

类型

void

设置网络摄像头(启用,设备 ID)→ {承诺 | 承诺。 < {代码: WebcamErrorCode,消息:字符串} >}

启用或禁用网络摄像头。

参数:

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

返回值:

-承诺,如果成功,将解析为附加/分离的网络摄像头设备 ID。如果拒绝,则 promise 返回一个错误对象。

类型

承诺 | 承诺。 < {代码: 网络摄像机代码,消息:字符串} >

同步剪贴板 () → {布尔值}

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

返回值:

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

类型

布尔值