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

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

Connection 类

调用 dcv 模块的 connect 方法获取的 Connection 类。有关说明如何使用该类的示例，请参阅入门一节。

方法

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

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

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

captureClipboardEvents（启用、获胜、displayID）→ {void}

开始或停止侦听复制粘贴事件。对于交互式剪贴板（对于粘贴，始终如此），我们需要开始侦听复制/粘贴事件。仅在需要时（例如，在显示模式时）开始和停止侦听可能是非常有用的。

参数：

返回值:

detachDisplay(displayId) → {void}

断开连接特定的显示器。无法断开连接主显示器。

参数：

返回值:

disconnect() → {void}

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

返回值:

disconnectCollaborator(connectionId) → {void}

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

参数：

返回值:

enableDisplayQuality更新（启用）→ {无效}

为不接收更新的流区域启用或禁用显示质量更新。禁用显示质量更新将减少带宽使用量，但也会降低显示质量。

参数：

返回值:

enableHighPixel密度（启用）→ {void}

在客户端上启用或禁用高像素密度。

参数：

返回值:

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

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

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

enterRelativeMouse模式 () → {无效}

启用相对鼠标模式。

返回值:

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

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

返回值:

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

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

获取一个对象以管理 Amazon DCV 服务器的文件存储。

返回值:

Promise。如果完成，则解析为文件资源管理器对象；如果被拒绝，则解析为错误对象。

getServerInfo() → {服务器信息}

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

返回值:

有关服务器软件的信息。

获取屏幕截图 () → {Promise|Promise。 < {code: ScreenshotErrorCode，消息：字符串} >}

检索 PNG 格式的远程桌面屏幕截图。屏幕截图将在 screenshotCallback 观察者中返回。如果失败，将返回 null。

返回值:

在处理了请求时解析的 Promise。如果被拒绝，我们将收到一个错误对象。

getStats() → {stats}

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

返回值:

有关流式传输统计信息的信息。

latchModifierKey（密钥、位置、isDown）→ {布尔值}

为允许的修饰键发送单个键盘 keydown 或 keyup 事件。

参数：

返回值:

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

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

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

参数：

返回值:

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

queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}

查询特定 Amazon DCV 服务器特征的状态。

参数：

返回值:

Promise。如果已解析，该函数返回一个 status 对象，该对象始终包含 enabled 属性，并且还可能包含其他属性。如果被拒绝，该函数返回一个 error 对象。

registerKeyboardShortcuts（快捷方式）→ {无效}

注册键盘快捷键。

参数：

返回值:

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

从 Amazon DCV 服务器中请求更新的显示配置。自 Amazon DCV Web Client SDK 1.1.0 和 Amazon DCV Server 2022.0 起提供。

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

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

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

参数：

返回值:

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

请求解决方案（宽度、高度）→ {Promise|Promise。 < {code: ResolutionErrorCode，消息：字符串} >}

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

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

sendKeyboardEvent（事件）→ {布尔值}

发送键盘快捷键事件。有关键盘事件的更多信息，请参阅 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（快捷方式）→ {无效}

发送键盘快捷键。可以使用该函数发送完整 keydown 或 keyup 序列。例如，在发送 Ctrl + Alt + Del 时，将发送所有按键的 keydown 事件，然后发送 keyup 事件。即使您希望发送单个键，也可以使用该函数。

参数：

返回值:

setDisplayQuality（min，maxopt）→ {void}

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

参数：

返回值:

setDisplayScale（scaleRatio，displayID）→ {Promise|Promise。 < {code: ResolutionErrorCode，消息：字符串} >}（已弃用）

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

通知 Amazon DCV 在客户端缩放了显示比例。可以使用该函数通知服务器，需要缩放鼠标事件以与客户端的显示比率匹配。

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

setKeyboardQuirks（怪癖）→ {void}

设置客户端计算机的键盘特性。

参数：

返回值:

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

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

参数：

返回值:

设置麦克风（启用）→ {Promise|Promise。 < {code: AudioErrorCode，消息：字符串} >}

启用或禁用麦克风。

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

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

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

参数：

返回值:

setUploadBandwidth（值）→ {数字}

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

参数：

返回值:

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

setVolume(volume) → {void}

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

参数：

返回值:

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

[实验性 - 未来可能会改变] 启用或禁用麦克风。

参数：

返回值:

Promise。如果被拒绝，Promise 返回一个错误对象。

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

启用或禁用网络摄像头。

参数：

返回值:

Promise，如果成功，将解析为连接/断开连接的网络摄像头的 deviceId。如果被拒绝，Promise 返回一个错误对象。

syncClipboards() → {boolean}

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

返回值:

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