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

# Connection 类
<a name="connection-class"></a>

调用 `dcv` 模块的 [`connect` 方法](dcv-module.md#connect)获取的 Connection 类。有关说明如何使用该类的示例，请参阅[入门](establish-connection.md#auth-conn)一节。

**Topics**
+ [

## 方法
](#methods)

## 方法
<a name="methods"></a>

**Topics**
+ [

### attachDisplay（赢了，DisplayConf）→ \$1Pro <number>\$1承诺。 < \$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)，消息：字符串\$1 >\$1
](#attachDisplay)
+ [

### captureClipboardEvents（启用、获胜、displayID）→ \$1void\$1
](#captureClipboardEvents)
+ [

### detachDisplay(displayId) → \$1void\$1
](#detachDisplay)
+ [

### disconnect() → \$1void\$1
](#disconnect)
+ [

### disconnectCollaborator(connectionId) → \$1void\$1
](#disconnectCollaborator)
+ [

### enableDisplayQuality更新（启用）→ \$1无效\$1
](#enableDisplayQualityUpdates)
+ [

### enableHighPixel密度（启用）→ \$1void\$1
](#enableHighPixelDensity)
+ [

### enableTimezoneRedirection（启用）→ \$1Promise\$1Promise。 < \$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)，消息：字符串\$1 >\$1
](#enableTimezoneRedirection)
+ [

### enterRelativeMouse模式 () → \$1void\$1
](#enterRelativeMouseMode)
+ [

### getConnectedDevices() → \$1承诺。 <数组。 < MediaDeviceInfo >>\$1承诺。 < \$1message: string\$1 >\$1
](#getConnectedDevices)
+ [

### getFileExplorer() → \$1承诺。 < [文件存储 >\$1承诺](dcv-module.md#filestorage)。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 >\$1
](#getFileExplorer)
+ [

### getServerInfo() → \$1[ServerInfo](dcv-module.md#serverInfo)\$1
](#getServerInfo)
+ [

### 获取屏幕截图 () → \$1Promise\$1Promise。 < \$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)，消息：字符串\$1 >\$1
](#getScreenshot)
+ [

### getStats() → \$1[stats](dcv-module.md#stats)\$1
](#getStats)
+ [

### latchModifierKey（密钥、位置、isDown）→ \$1boolean\$1
](#latchModifierKey)
+ [

### OpenChannel（名称、authToken、回调、命名空间）→ \$1Promise\$1Promise。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 >\$1
](#openChannel)
+ [

### queryFeature(featureName) → \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1>\$1Promise.<\$1message: string\$1>\$1
](#queryFeature)
+ [

### registerKeyboardShortcuts（快捷方式）→ \$1void\$1
](#registerKeyboardShortcuts)
+ [

### requestDisplayConfig(highColorAccuracy) → \$1Promise\$1Promise。 < \$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)，消息：字符串\$1 >\$1
](#requestDisplayConfig)
+ [

### requestDisplayLayout（布局）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1
](#requestDisplayLayout)
+ [

### 请求分辨率（宽度、高度）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1
](#requestResolution)
+ [

### sendKeyboardEvent（事件）→ \$1布尔值\$1
](#sendKeyboardEvent)
+ [

### sendKeyboardShortcut（快捷方式）→ \$1无效\$1
](#sendKeyboardShortcut)
+ [

### setDisplayQuality（min，maxopt）→ \$1void\$1
](#setDisplayQuality)
+ [

### setDisplayScale（scaleRatio，displayID）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1（已弃用）
](#setDisplayScale)
+ [

### setKeyboardQuirks（怪癖）→ \$1void\$1
](#setKeyboardQuirks)
+ [

### setMaxDisplay分辨率（maxWidth、maxHeight）→ \$1void\$1
](#setMaxDisplayResolution)
+ [

### 设置麦克风（启用）→ \$1Promise\$1Promise。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 >\$1
](#setMicrophone)
+ [

### setMinDisplay分辨率（minWidth、minHeight）→ \$1void\$1
](#setMinDisplayResolution)
+ [

### setUploadBandwidth（值）→ \$1数字\$1
](#setUploadBandwidth)
+ [

### setVolume(volume) → \$1void\$1
](#setVolume)
+ [

### setMicrocone（启用，deviceID）→ \$1Promise\$1Promise。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 >\$1
](#setMicrophone)
+ [

### setWebcam（启用，deviceID）→ \$1Promise\$1Promise。 < \$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode)，消息：字符串\$1 >\$1
](#setWebcam)
+ [

### syncClipboards() → \$1boolean\$1
](#syncClipboards)

### attachDisplay（赢了，DisplayConf）→ \$1Pro <number>\$1承诺。 < \$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)，消息：字符串\$1 >\$1
<a name="attachDisplay"></a>

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

#### 参数：
<a name="parameters-1"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  属性  |  说明  | 
| --- | --- | --- | --- | 
|  win  |  对象  |  必须将显示器连接到的窗口。 | 
|  displayConf  |  对象  |  显示器的配置。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  displayId  |  数字  |  <可选>  |  显示器的 ID。 | 
|  displayDivName  |   |   |  显示器 div 的名称。 | 

#### 返回值:
<a name="returns"></a>

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

 Type   
 承诺。 <number>\$1 承诺。 < \$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)，消息：字符串\$1 > 

### captureClipboardEvents（启用、获胜、displayID）→ \$1void\$1
<a name="captureClipboardEvents"></a>

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

#### 参数：
<a name="parameters-2"></a>


|  Name  |  Type  |  属性  |  说明  | 
| --- | --- | --- | --- | 
|  enabled  |  布尔值  |   |  要开始侦听事件，请指定 true。要停止侦听事件，请指定 false。 | 
|  win  |  对象  |  <可选>  |  在其中侦听事件的窗口。如果省略，则使用默认窗口。 | 
|  displayId  |  数字  |  <可选>  |  应侦听事件的显示器的 ID。如果省略，则使用窗口的默认显示器。 | 

#### 返回值:
<a name="returns-1"></a>

 Type   
 void 

### detachDisplay(displayId) → \$1void\$1
<a name="detachDisplay"></a>

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

#### 参数：
<a name="parameters-3"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  displayId  |  数字  |  要断开连接的显示器的 ID。 | 

#### 返回值:
<a name="returns-2"></a>

 Type   
 void 

### disconnect() → \$1void\$1
<a name="disconnect"></a>

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

#### 返回值:
<a name="returns-3"></a>

 Type   
 void 

### disconnectCollaborator(connectionId) → \$1void\$1
<a name="disconnectCollaborator"></a>

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

#### 参数：
<a name="parameters-4"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  connectionId  |  布尔值  |  将断开的连接的 ID。 | 

#### 返回值:
<a name="returns-4"></a>

 Type   
 void 

### enableDisplayQuality更新（启用）→ \$1无效\$1
<a name="enableDisplayQualityUpdates"></a>

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

#### 参数：
<a name="parameters-5"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  要启用显示质量更新，请指定 true。要禁用显示质量更新，请指定 false。 | 

#### 返回值:
<a name="returns-5"></a>

 Type   
 void 

### enableHighPixel密度（启用）→ \$1void\$1
<a name="enableHighPixelDensity"></a>

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

#### 参数：
<a name="parameters-5"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  是否应启用高像素密度。 | 

#### 返回值:
<a name="returns-5"></a>

 Type   
 void 

### enableTimezoneRedirection（启用）→ \$1Promise\$1Promise。 < \$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)，消息：字符串\$1 >\$1
<a name="enableTimezoneRedirection"></a>

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

#### 参数：
<a name="parameters-5"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  要启用时区重定向，请指定 true。要禁用时区重定向，请指定 false。 | 

#### 返回值:
<a name="returns-5"></a>

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

 Type   
 承诺。 <number>\$1 承诺。 < \$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)，消息：字符串\$1 > 

### enterRelativeMouse模式 () → \$1void\$1
<a name="enterRelativeMouseMode"></a>

 启用相对鼠标模式。

#### 返回值:
<a name="returns65"></a>

 Type   
 void 

### getConnectedDevices() → \$1承诺。 <数组。 < MediaDeviceInfo >>\$1承诺。 < \$1message: string\$1 >\$1
<a name="getConnectedDevices"></a>

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

#### 返回值:
<a name="returns-7"></a>

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

 Type   
 承诺。 <数组。 < MediaDeviceInfo >> \$1 承诺。 < \$1message: string\$1 > 

### getFileExplorer() → \$1承诺。 < [文件存储 >\$1承诺](dcv-module.md#filestorage)。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 >\$1
<a name="getFileExplorer"></a>

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

#### 返回值:
<a name="returns-8"></a>

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

 Type   
 承诺。 < [文件存储](dcv-module.md#filestorage) > \$1 承诺。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 > 

### getServerInfo() → \$1[ServerInfo](dcv-module.md#serverInfo)\$1
<a name="getServerInfo"></a>

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

#### 返回值:
<a name="returns-9"></a>

 有关服务器软件的信息。

 Type   
 [serverInfo](dcv-module.md#serverInfo) 

### 获取屏幕截图 () → \$1Promise\$1Promise。 < \$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)，消息：字符串\$1 >\$1
<a name="getScreenshot"></a>

 检索 PNG 格式的远程桌面屏幕截图。屏幕截图将在 [screenshotCallback](dcv-module.md#screenshotCallback) 观察者中返回。如果失败，将返回 `null`。

#### 返回值:
<a name="returns-30"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)，消息：字符串\$1 > 

### getStats() → \$1[stats](dcv-module.md#stats)\$1
<a name="getStats"></a>

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

#### 返回值:
<a name="returns-10"></a>

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

 Type   
 [stats](dcv-module.md#stats) 

### latchModifierKey（密钥、位置、isDown）→ \$1boolean\$1
<a name="latchModifierKey"></a>

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

#### 参数：
<a name="parameters-6"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  key  |  控制 \$1 Alt \$1 \$1 Meta AltGraph \$1 OS \$1 Shift  |  要发送的键。 | 
|  location  |  KeyboardEvent. 位置  |  键的位置。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/location。 | 
|  isDown  |  布尔值  |  如果要注入的按键事件是 keydown（true）或 keyup（false）。 | 

#### 返回值:
<a name="returns-11"></a>

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

 Type   
 布尔值 

### OpenChannel（名称、authToken、回调、命名空间）→ \$1Promise\$1Promise。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 >\$1
<a name="openChannel"></a>

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

#### 参数：
<a name="parameters-7"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  name  |  字符串  |  通道的名称。 | 
|  authToken  |  字符串  |  用于连接到通道的身份验证令牌。 | 
|  callbacks  |  对象  |  要调用的 onMessage 和 onClose 回调函数。 | 
|  namespace  |  字符串  |  通道的命名空间。自 Amazon DCV Web Client SDK 1.2.0 和 Amazon DCV Server 2022.1 起提供。 | 

#### 返回值:
<a name="returns-12"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode)，消息：字符串\$1 > 

### queryFeature(featureName) → \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1>\$1Promise.<\$1message: string\$1>\$1
<a name="queryFeature"></a>

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

#### 参数：
<a name="parameters-8"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  featureName  |  [feature](dcv-module.md#feature)  |  要查询的功能的名称。 | 

#### 返回值:
<a name="returns-13"></a>

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

 Type   
 \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1> \$1 Promise.<\$1message: string\$1> 

### registerKeyboardShortcuts（快捷方式）→ \$1void\$1
<a name="registerKeyboardShortcuts"></a>

 注册键盘快捷键。

#### 参数：
<a name="parameters-9"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  shortcuts  |  Array.<Object>  |  要注册的键和映射的数组。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  sequence  |  Array.<Object>  |  要注册的键盘快捷键。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  output  |  Array.<Object>  |  快捷键执行的预期操作。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.key  |  用户按下的键的值。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent. 位置  |  要发送的键的数组。键盘上的键的位置。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/location。 | 
|  key  |  KeyboardEvent.key  |  用户按下的键的值。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent. 位置  |  要发送的键的数组。键盘上的键的位置。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/location。 | 

#### 返回值:
<a name="returns-14"></a>

 Type   
 void 

### requestDisplayConfig(highColorAccuracy) → \$1Promise\$1Promise。 < \$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)，消息：字符串\$1 >\$1
<a name="requestDisplayConfig"></a>

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

#### 参数：
<a name="parameters-10"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  highColorAccuracy  |  布尔值  |  是否应请求高色彩精度。 | 

#### 返回值:
<a name="returns-15"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)，消息：字符串\$1 > 

### requestDisplayLayout（布局）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1
<a name="requestDisplayLayout"></a>

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

#### 参数：
<a name="parameters-11"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  layout  |  Array.<[Monitor](dcv-module.md#Monitor)>  |  请求的内容显示在布局中。 | 

#### 返回值:
<a name="returns-16"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 > 

### 请求分辨率（宽度、高度）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1
<a name="requestResolution"></a>

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

#### 参数：
<a name="parameters-12"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  width  |  数字  |  请求的宽度（以像素为单位）。最小的允许值为 0。 | 
|  height  |  数字  |  请求的高度（以像素为单位）。最小的允许值为 0。 | 

#### 返回值:
<a name="returns-17"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 > 

### sendKeyboardEvent（事件）→ \$1布尔值\$1
<a name="sendKeyboardEvent"></a>

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

#### 参数：
<a name="parameters-13"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  event  |  KeyboardEvent  |  要发送的键盘事件。 | 

#### 返回值:
<a name="returns-18"></a>

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

 Type   
 布尔值 

### sendKeyboardShortcut（快捷方式）→ \$1无效\$1
<a name="sendKeyboardShortcut"></a>

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

#### 参数：
<a name="parameters-14"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  shortcut  |  Array.<Object>  |  要发送的键的数组。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.key  |  用户按下的键的值。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent. 位置  |  要发送的键的数组。键盘上的键的位置。欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/KeyboardEvent/location。 | 

#### 返回值:
<a name="returns-19"></a>

 Type   
 void 

### setDisplayQuality（min，maxopt）→ \$1void\$1
<a name="setDisplayQuality"></a>

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

#### 参数：
<a name="parameters-15"></a>


|  Name  |  Type  |  属性  |  说明  | 
| --- | --- | --- | --- | 
|  min  |  数字  |   |  最低图像质量。 | 
|  max  |  数字  |  <可选>  |  最高图像质量。 | 

#### 返回值:
<a name="returns-20"></a>

 Type   
 void 

### setDisplayScale（scaleRatio，displayID）→ \$1Promise\$1Promise。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 >\$1（已弃用）
<a name="setDisplayScale"></a>

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

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

#### 参数：
<a name="parameters-16"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  scaleRatio  |  浮点数  |  要使用的缩放比率。必须是严格的正数。 | 
|  displayId  |  数字  |  要缩放的显示器的 ID。 | 

#### 返回值:
<a name="returns-21"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)，消息：字符串\$1 > 

### setKeyboardQuirks（怪癖）→ \$1void\$1
<a name="setKeyboardQuirks"></a>

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

#### 参数：
<a name="parameters-17"></a>


|  Name  |  Type  |  说明  | 
| --- | --- | --- | 
|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  quirks  |  对象  |  要启用或禁用的键盘特性。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/connection-class.html)  | 
|  macOptionToAlt  |  布尔值  |  对于 macOS，要将 Option 键映射到 Alt，请指定 true。否则，请指定 false。 | 
|  macCommandToControl  |  布尔值  |  对于 macOS，要将 Command 键映射到 Ctrl，请指定 true。否则，请指定 false。 | 

#### 返回值:
<a name="returns-22"></a>

 Type   
 void 

### setMaxDisplay分辨率（maxWidth、maxHeight）→ \$1void\$1
<a name="setMaxDisplayResolution"></a>

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

#### 参数：
<a name="parameters-18"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  maxWidth  |  数字  |  最大显示宽度（以像素为单位）。最小的允许值为 0。 | 
|  maxHeight  |  数字  |  最大显示高度（以像素为单位）。最小的允许值为 0。 | 

#### 返回值:
<a name="returns-23"></a>

 Type   
 void 

### 设置麦克风（启用）→ \$1Promise\$1Promise。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 >\$1
<a name="setMicrophone"></a>

 启用或禁用麦克风。

#### 参数：
<a name="parameters-19"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  要启用麦克风，请指定 true。要禁用麦克风，请指定 false。 | 

#### 返回值:
<a name="returns-24"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 > 

### setMinDisplay分辨率（minWidth、minHeight）→ \$1void\$1
<a name="setMinDisplayResolution"></a>

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

#### 参数：
<a name="parameters-20"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  minWidth  |  数字  |  最小显示宽度（以像素为单位）。最小的允许值为 0。 | 
|  minHeight  |  数字  |  最小显示高度（以像素为单位）。最小的允许值为 0。 | 

#### 返回值:
<a name="returns-25"></a>

 Type   
 void 

### setUploadBandwidth（值）→ \$1数字\$1
<a name="setUploadBandwidth"></a>

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

#### 参数：
<a name="parameters-21"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  value  |  数字  |  最大带宽限制（以 kbps 为单位）。有效范围是 1024 kbps 到 102400 kbps。 | 

#### 返回值:
<a name="returns-26"></a>

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

 Type   
 数字 

### setVolume(volume) → \$1void\$1
<a name="setVolume"></a>

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

#### 参数：
<a name="parameters-22"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  volume  |  数字  |  要使用的音量。 | 

#### 返回值:
<a name="returns-27"></a>

 Type   
 void 

### setMicrocone（启用，deviceID）→ \$1Promise\$1Promise。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 >\$1
<a name="setMicrophone"></a>

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

#### 参数：
<a name="parameters-23"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  要启用麦克风，请指定 true。要禁用麦克风，请指定 false。 | 
|  deviceId  |  字符串  |  麦克风的设备 ID。如果未提供 deviceId，则使用 default deviceId。 | 

#### 返回值:
<a name="returns-28"></a>

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

 Type   
 承诺 \$1 承诺。 < \$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode)，消息：字符串\$1 > 

### setWebcam（启用，deviceID）→ \$1Promise\$1Promise。 < \$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode)，消息：字符串\$1 >\$1
<a name="setWebcam"></a>

 启用或禁用网络摄像头。

#### 参数：
<a name="parameters-23"></a>


|  Name  |  Type  |  描述  | 
| --- | --- | --- | 
|  enable  |  布尔值  |  要启用网络摄像头，请指定 true。要禁用网络摄像头，请指定 false。 | 
|  deviceId  |  字符串  |  网络摄像头的设备 ID。 | 

#### 返回值:
<a name="returns-28"></a>

 保证，如果成功，将解析为 attached/detached 网络摄像头 deviceID。如果被拒绝，Promise 返回一个错误对象。

 Type   
 承诺。 <string>\$1 承诺。 < \$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode)，消息：字符串\$1 > 

### syncClipboards() → \$1boolean\$1
<a name="syncClipboards"></a>

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

#### 返回值:
<a name="returns-29"></a>

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

 Type   
 布尔值