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

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

连接类

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

Expose

方法

List

attachDisplay(赢,displayConf)→ {Promis <number>|承诺。 < {code: MultiMonitorErrorCode,消息:字符串} >}

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

参数:

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

返回值:

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

类型

承诺。 <number>| 承诺。 < {code: MultiMonitorErrorCode,消息:字符串} >

captureClipboardEvents(启用、赢了、displayID)→ {void}

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

参数:

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

返回值:

类型

void

detachDisplay (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

enterRelativeMouse模式 () → {void}

启用相对鼠标模式。

返回值:

类型

void

getConnectedDevices() → {Promise。 <阵列。 <MediaDeviceInfo>>|承诺。 < {message: string} >}

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

返回值:

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

类型

承诺。 <阵列。 <MediaDeviceInfo>> | 承诺。 < {message: string} >

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

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

返回值:

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

类型

承诺。 <文件存储> | 承诺。 < {code: ChannelErrorCode,消息:字符串} >

getServerInfo() → {服务器信息}

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

返回值:

有关服务器软件的信息。

getScreenscreent () → {Promise|Pro < {code: ScreenshotErrorCode,消息:字符串} >}

检索 PNG 格式的远程桌面的屏幕截图。屏幕截图将在屏幕截图回调观察员。null将在失败时返回。

返回值:

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

类型

承诺 | 承诺。 < {code: ScreenshotErrorCode,消息:字符串} >

getStats () → {统计数据}

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

返回值:

有关流统计信息的信息。

类型

统计数据

latchModifierKey(键、位置、isDown)→ {boolean}

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

参数:

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

返回值:

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

类型

布尔值

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

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

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: ChannelErrorCode,消息:字符串} >

queryFeature (featureName) → {Promise < {已启用:布尔值、远程? : string,自动复制? : 布尔值,AutoPaste? : 布尔值,ServiceStatus? : 字符串,可用吗? : 布尔值} >|承诺。 < {message: string} >}

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

参数:

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

返回值:

承诺。如果已解决,该函数会返回status对象总是包含enabled属性,可能还有其他属性。如果被拒绝,该函数会返回error对象。

类型

承诺。 < {已启用:布尔值、远程? : string,自动复制? : 布尔值,AutoPaste? : 布尔值,ServiceStatus? : 字符串,可用吗? : 布尔值} > | Promise。 < {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/location
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/location

返回值:

类型

void

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

向 NICE DCV 服务器请求更新的显示配置。自 NICE DCV Web Client SDK 1.1.0 和 NICE DCV 服务器 2022.0 起推出。

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: DisplayConfigErrorCode,消息:字符串} >

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

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

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:字符串} >

requestResolution (width, height)。 < {code: ResolutionErrorCode,消息:字符串} >}

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

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:字符串} >

sendKeyboardEvent(事件) → {boolean}

发送键盘快捷键事件。有关键盘事件的更多信息,请参阅。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/location

返回值:

类型

void

setDisplayQuality(分钟,maxopt)→ {void}

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

参数:

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

返回值:

类型

void

setDisplayScale(scaleRatio,displayID) → {Promise|Promise < {code: ResolutionErrorCode,消息:字符串} >}

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

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: ResolutionErrorCode,消息:字符串} >

setKeyboardQuirks(怪癖)→ {void}

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

参数:

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

返回值:

类型

void

setMaxDisplay分辨率(maxWidth、maxHeight)→ {void}

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

参数:

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

返回值:

类型

void

setMicrope(启用)→ {Promise|Promise。 < {code: AudioErrorCode,消息:字符串} >}

启用或禁用麦克风。

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: AudioErrorCode,消息:字符串} >

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(启用,deviceID)→ {Promise|Promise。 < {code: WebcamErrorCode,消息:字符串} >}

启用或禁用网络摄像头。

参数:

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

返回值:

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

类型

承诺 | 承诺。 < {code: WebcamErrorCode,消息:字符串} >

syncClipboards () → {boolean}

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

返回值:

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

类型

布尔值