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

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

连接类

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

方法

attachDisplay（赢，displayConf）→ {Promis <number>|承诺。 < {code: MultiMonitorErrorCode，消息：字符串} >}

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

参数：

返回值:

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

captureClipboardEvents（启用、赢了、displayID）→ {void}

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

参数：

返回值:

detachDisplay (displayID) → {void}

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

参数：

返回值:

断开连接 () → {void}

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

返回值:

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

请求断开使用提供的连接 ID 连接的协作者连接（自 NICE DCV Web Client SDK 版本 1.1.0 起）。

参数：

返回值:

enableDisplayQuality更新（启用）→ {void}

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

参数：

返回值:

enterRelativeMouse模式 () → {void}

启用相对鼠标模式。

返回值:

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

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

返回值:

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

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

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

返回值:

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

getServerInfo() → {服务器信息}

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

返回值:

有关服务器软件的信息。

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

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

返回值:

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

getStats () → {统计数据}

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

返回值:

有关流统计信息的信息。

latchModifierKey（键、位置、isDown）→ {boolean}

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

参数：

返回值:

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

OpenChannel（名称、authToken、回调、命名空间）→ {Promise|Promise。 < {code: ChannelErrorCode，消息：字符串} >}

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

参数：

返回值:

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

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

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

参数：

返回值:

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

registerKeyboardShortcuts（快捷键）→ {void}

注册键盘快捷键。

参数：

返回值:

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

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

参数：

返回值:

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

requestDisplayLayout（布局）→ {Promise|Promise。 < {code: ResolutionErrorCode，消息：字符串} >}

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

参数：

返回值:

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

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

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

参数：

返回值:

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

sendKeyboardEvent(事件) → {boolean}

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

参数：

返回值:

如果事件无效，则函数返回false. 如果事件有效，该函数返回。true.

sendKeyboardShortcut（快捷键）→ {void}

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

参数：

返回值:

setDisplayQuality（分钟，maxopt）→ {void}

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

参数：

返回值:

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

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

参数：

返回值:

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

setKeyboardQuirks（怪癖）→ {void}

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

参数：

返回值:

setMaxDisplay分辨率（maxWidth、maxHeight）→ {void}

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

参数：

返回值:

setMicrope（启用）→ {Promise|Promise。 < {code: AudioErrorCode，消息：字符串} >}

启用或禁用麦克风。

参数：

返回值:

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

setMinDisplay分辨率（minWidth、minHeight）→ {void}

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

参数：

返回值:

setUploadBandwidth（值）→ {数字}

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

参数：

返回值:

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

setVolume（音量）→ {void}

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

参数：

返回值:

setWebcam（启用，deviceID）→ {Promise|Promise。 < {code: WebcamErrorCode，消息：字符串} >}

启用或禁用网络摄像头。

参数：

返回值:

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

syncClipboards () → {boolean}

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

返回值:

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