本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 連線類別
<a name="connection-class"></a>

呼叫 `dcv`模組的 [`connect`方法](dcv-module.md#connect)所取得的連線類別。如需示範如何使用的範例，請參閱[入門](establish-connection.md#auth-conn)一節。

**Topics**
+ [方法](#methods)

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

**Topics**
+ [attachDisplay(win， displayConf) → {Promise.<number>\|Promise.<{code： [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)， message： string}>}](#attachDisplay)
+ [captureClipboardEvents（啟用， win， displayId) → {void}](#captureClipboardEvents)
+ [detachDisplay(displayId) → {void}](#detachDisplay)
+ [disconnect() → {void}](#disconnect)
+ [disconnectCollaborator(connectionId) → {void}](#disconnectCollaborator)
+ [enableDisplayQualityUpdates（啟用） → {void}](#enableDisplayQualityUpdates)
+ [enableHighPixelDensity(enable) → {void}](#enableHighPixelDensity)
+ [enableTimezoneRedirection(enable) → {Promise\|Promise.<{code： [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)， message： string}>}](#enableTimezoneRedirection)
+ [enterRelativeMouseMode() → {void}](#enterRelativeMouseMode)
+ [getConnectedDevices() → {Promise.<陣列。<MediaDeviceInfo>>\|Promise.<{message： string}>}](#getConnectedDevices)
+ [getFileExplorer() → {Promise.<[filestorage](dcv-module.md#filestorage)>\|Promise.<{code： [ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}>}](#getFileExplorer)
+ [getMaxAllowedMonitorDimensions() {[MaxDimensionLimits](dcv-module.md#MaxDimensionLimits)}](#getMaxAllowedMonitorDimensions)
+ [getServerInfo() → {[serverInfo](dcv-module.md#serverInfo)}](#getServerInfo)
+ [getScreenshot() → {Promise\|Promise.<{code： [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)， message： string}>}](#getScreenshot)
+ [getStats() → {[stats](dcv-module.md#stats)}](#getStats)
+ [latchModifierKey（金鑰、位置、isDown) → {布林值}](#latchModifierKey)
+ [openChannel(name， authToken， callbacks， namespace) → {Promise\|Promise.<{code： [ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}>}](#openChannel)
+ [queryFeature(featureName) → {Promise.<{enabled： boolean， remote？： string， autoCopy？： boolean， autoPaste？： boolean， serviceStatus？： string， available？： boolean}>\|Promise.<{message： string}>}](#queryFeature)
+ [registerKeyboardShortcuts（快速鍵） → {void}](#registerKeyboardShortcuts)
+ [requestDisplayConfig(highColorAccuracy) → {Promise\|Promise.<{code： [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)， message： string}>}](#requestDisplayConfig)
+ [requestDisplayLayout（配置） → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>}](#requestDisplayLayout)
+ [requestResolution（寬度，高度） → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>}](#requestResolution)
+ [sendKeyboardEvent(event) → {布林值}](#sendKeyboardEvent)
+ [sendKeyboardShortcut(shortcut) → {void}](#sendKeyboardShortcut)
+ [setDisplayQuality(min， maxopt) → {void}](#setDisplayQuality)
+ [setDisplayScale(scaleRatio， displayId) → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>} (DEPRECATED)](#setDisplayScale)
+ [setKeyboardQuirks(quirks) → {void}](#setKeyboardQuirks)
+ [setMaxDisplayResolution(maxWidth， maxHeight) → {void}](#setMaxDisplayResolution)
+ [setMicrophone（啟用） → {Promise\|Promise.<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}>}](#setMicrophone)
+ [setMinDisplayResolution(minWidth， minHeight) → {void}](#setMinDisplayResolution)
+ [setUploadBandwidth（值） → {number}](#setUploadBandwidth)
+ [setVolume(volume) → {void}](#setVolume)
+ [setMicrophone（啟用， deviceId) → {Promise\|Promise.<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}>}](#setMicrophone)
+ [setWebcam（啟用， deviceId) → {Promise\|Promise.<{code： [WebcamErrorCode](dcv-module.md#WebcamErrorCode)， message： string}>}](#setWebcam)
+ [syncClipboards() → {布林值}](#syncClipboards)

### attachDisplay(win， displayConf) → {Promise.<number>\|Promise.<{code： [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)， message： string}>}
<a name="attachDisplay"></a>

 將特定顯示附加至視窗。您無法連接主要顯示器。如果成功，函數會傳回 `displayId`。

#### 參數：
<a name="parameters-1"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  屬性  |  Description  | 
| --- | --- | --- | --- | 
|  win  |  物件  |  必須連接顯示所在的視窗。 | 
|  displayConf  |  物件  |  顯示的組態。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  displayId  |  number  |  <選用>  |  顯示的 ID。 | 
|  displayDivName  |   |   |  顯示 div 的名稱。 | 

#### 傳回：
<a name="returns"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise.<number> \| Promise.<{code： [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode)， message： string}> 

### captureClipboardEvents（啟用， win， displayId) → {void}
<a name="captureClipboardEvents"></a>

 開始或停止接聽複製貼上事件。如果是互動式剪貼簿 （一律是貼上），我們需要開始聆聽複製/貼上事件。只有在需要時才開始和停止接聽可能很有用，例如，顯示模態時。

#### 參數：
<a name="parameters-2"></a>


|  名稱  |  類型  |  屬性  |  Description  | 
| --- | --- | --- | --- | 
|  enabled  |  boolean  |   |  若要開始接聽事件，請指定 true。若要停止接聽事件，請指定 false。 | 
|  win  |  物件  |  <選用>  |  要接聽事件的視窗。如果省略，則會使用預設視窗。 | 
|  displayId  |  number  |  <選用>  |  應該監聽事件的顯示器 ID。如果省略，則會使用視窗的預設顯示。 | 

#### 傳回：
<a name="returns-1"></a>

 Type   
 void 

### detachDisplay(displayId) → {void}
<a name="detachDisplay"></a>

 分離特定顯示。主要顯示器無法分離。

#### 參數：
<a name="parameters-3"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  displayId  |  number  |  要分離的顯示器 ID。 | 

#### 傳回：
<a name="returns-2"></a>

 Type   
 void 

### disconnect() → {void}
<a name="disconnect"></a>

 中斷與 Amazon DCV 伺服器的連線，並關閉連線。

#### 傳回：
<a name="returns-3"></a>

 Type   
 void 

### disconnectCollaborator(connectionId) → {void}
<a name="disconnectCollaborator"></a>

 請求中斷與所提供連線 ID （自 Amazon DCV Web 用戶端 SDK 1.1.0 版起） 連線的協作器連線。

#### 參數：
<a name="parameters-4"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  connectionId  |  boolean  |  將中斷連線的連線 ID。 | 

#### 傳回：
<a name="returns-4"></a>

 Type   
 void 

### enableDisplayQualityUpdates（啟用） → {void}
<a name="enableDisplayQualityUpdates"></a>

 針對未接收更新的串流區域啟用或停用顯示品質更新。停用顯示品質更新可減少頻寬使用量，但也會降低顯示品質。

#### 參數：
<a name="parameters-5"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  若要啟用顯示品質更新，請指定 true。若要停用顯示品質更新，請指定 false。 | 

#### 傳回：
<a name="returns-5"></a>

 Type   
 void 

### enableHighPixelDensity(enable) → {void}
<a name="enableHighPixelDensity"></a>

 在用戶端上啟用或停用高像素密度。

#### 參數：
<a name="parameters-5"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  是否應啟用高像素密度。 | 

#### 傳回：
<a name="returns-5"></a>

 Type   
 void 

### enableTimezoneRedirection(enable) → {Promise\|Promise.<{code： [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)， message： string}>}
<a name="enableTimezoneRedirection"></a>

 啟用或停用時區重新導向。啟用後，用戶端會請求伺服器讓伺服器桌面時區與用戶端時區相符。

#### 參數：
<a name="parameters-5"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  若要啟用時區重新導向，請指定 true。若要停用時區重新導向，請指定 false。 | 

#### 傳回：
<a name="returns-5"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise.<number> \| Promise.<{code： [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode)， message： string}> 

### enterRelativeMouseMode() → {void}
<a name="enterRelativeMouseMode"></a>

 啟用相對滑鼠模式。

#### 傳回：
<a name="returns65"></a>

 Type   
 void 

### getConnectedDevices() → {Promise.<陣列。<MediaDeviceInfo>>\|Promise.<{message： string}>}
<a name="getConnectedDevices"></a>

 請求連接至用戶端電腦的媒體裝置清單。

#### 傳回：
<a name="returns-7"></a>

 如果成功，它會傳回解析為 MediaDeviceInfo 物件陣列的 Promise。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise。<陣列。<MediaDeviceInfo>> \| Promise.<{message： string}> 

### getFileExplorer() → {Promise.<[filestorage](dcv-module.md#filestorage)>\|Promise.<{code： [ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}>}
<a name="getFileExplorer"></a>

 取得物件以管理 Amazon DCV 伺服器的檔案儲存。

#### 傳回：
<a name="returns-8"></a>

 Promise。如果已完成，則解析為檔案總管物件，如果已拒絕，則解析為錯誤物件。

 Type   
 Promise.<[filestorage](dcv-module.md#filestorage)> \| Promise.<{code： [ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}> 

### getMaxAllowedMonitorDimensions() {[MaxDimensionLimits](dcv-module.md#MaxDimensionLimits)}
<a name="getMaxAllowedMonitorDimensions"></a>

 請求 Amazon DCV 伺服器支援的顯示維度限制。

#### 傳回：
<a name="returns-35"></a>

 包含伺服器 Webclient 上支援的 maxLargestDimension 和 maxSmallestDimension 的物件。

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

### getServerInfo() → {[serverInfo](dcv-module.md#serverInfo)}
<a name="getServerInfo"></a>

 取得 Amazon DCV 伺服器的相關資訊。

#### 傳回：
<a name="returns-9"></a>

 伺服器軟體的相關資訊。

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

### getScreenshot() → {Promise\|Promise.<{code： [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)， message： string}>}
<a name="getScreenshot"></a>

 擷取 PNG 格式的遠端桌面螢幕擷取畫面。螢幕擷取畫面會在 [screenshotCallback](dcv-module.md#screenshotCallback) 觀察程式中傳回。 `null`將在失敗時傳回。

#### 傳回：
<a name="returns-30"></a>

 如果處理請求， 會解析的承諾。如果拒絕，我們會收到錯誤物件。

 Type   
 Promise \| Promise。<{code： [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode)， message： string}> 

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

 取得 Amazon DCV 伺服器的統計資料。

#### 傳回：
<a name="returns-10"></a>

 串流統計資料的相關資訊。

 Type   
 [統計資料](dcv-module.md#stats) 

### latchModifierKey（金鑰、位置、isDown) → {布林值}
<a name="latchModifierKey"></a>

 傳送允許修改器的單一鍵盤`keydown`或`keyup`事件。

#### 參數：
<a name="parameters-6"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  key  |  控制 \| Alt \| AltGraph \| Meta \| OS \| Shift  |  要傳送的金鑰。 | 
|  location  |  KeyboardEvent.location  |  金鑰的位置。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 | 
|  isDown  |  boolean  |  如果要注入的金鑰事件是 keydown (true) 或 keyup (false)。 | 

#### 傳回：
<a name="returns-11"></a>

 如果請求的組合有效，函數會傳回 `true`，否則會傳回 `false`。

 Type   
 boolean 

### openChannel(name， authToken， callbacks， namespace) → {Promise\|Promise.<{code： [ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}>}
<a name="openChannel"></a>

 如果在 Amazon DCV 伺服器上建立，請在連線上開啟自訂資料通道。

#### 參數：
<a name="parameters-7"></a>


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  name  |  string  |  頻道名稱。 | 
|  authToken  |  string  |  用於連線至頻道的身分驗證字符。 | 
|  callbacks  |  物件  |  要呼叫的 onMessage 和 onClose 回呼函數。 | 
|  namespace  |  string  |  頻道的命名空間。自 Amazon DCV Web 用戶端 SDK 1.2.0 和 Amazon DCV Server 2022.1 起提供。 | 

#### 傳回：
<a name="returns-12"></a>

 Promise。如果拒絕，我們會收到錯誤物件。

 Type   
 Promise \| Promise。<{code：[ChannelErrorCode](dcv-module.md#ChannelErrorCode)， message： string}> 

### queryFeature(featureName) → {Promise.<{enabled： boolean， remote？： string， autoCopy？： boolean， autoPaste？： boolean， serviceStatus？： string， available？： boolean}>\|Promise.<{message： string}>}
<a name="queryFeature"></a>

 查詢特定 Amazon DCV 伺服器功能的狀態。

#### 參數：
<a name="parameters-8"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  featureName  |  [功能](dcv-module.md#feature)  |  要查詢的功能名稱。 | 

#### 傳回：
<a name="returns-13"></a>

 Promise。如果已解決，函數會傳回物件，該`status`物件一律包含 `enabled` 屬性，也可能包含其他屬性。如果拒絕，函數會傳回 `error` 物件。

 Type   
 {Promise.<{enabled： boolean， remote？： string， autoCopy？： boolean， autoPaste？： boolean， serviceStatus？： string， available？： boolean}> \| Promise.<{message： string}> 

### registerKeyboardShortcuts（快速鍵） → {void}
<a name="registerKeyboardShortcuts"></a>

 註冊鍵盤快速鍵。

#### 參數：
<a name="parameters-9"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  shortcuts  |  陣列。<物件>  |  要註冊的金鑰和映射陣列。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  sequence  |  陣列。<物件>  |  要註冊的鍵盤快速鍵。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  output  |  陣列。<物件>  |  捷徑要執行的預期動作。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.key  |  使用者按下的金鑰值。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent.location  |  要傳送的金鑰陣列。鍵盤上金鑰的位置。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 | 
|  key  |  KeyboardEvent.key  |  使用者按下的金鑰值。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent.location  |  要傳送的金鑰陣列。鍵盤上金鑰的位置。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 | 

#### 傳回：
<a name="returns-14"></a>

 Type   
 void 

### requestDisplayConfig(highColorAccuracy) → {Promise\|Promise.<{code： [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)， message： string}>}
<a name="requestDisplayConfig"></a>

 從 Amazon DCV 伺服器請求更新的顯示組態。自 Amazon DCV Web 用戶端 SDK 1.1.0 和 Amazon DCV Server 2022.0 起提供。

#### 參數：
<a name="parameters-10"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  highColorAccuracy  |  boolean  |  是否應請求高顏色準確度。 | 

#### 傳回：
<a name="returns-15"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise \| Promise。<{code： [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode)， message： string}> 

### requestDisplayLayout（配置） → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>}
<a name="requestDisplayLayout"></a>

 請求更新連線的顯示配置。

#### 參數：
<a name="parameters-11"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  layout  |  陣列。<[Monitor](dcv-module.md#Monitor)>  |  請求會顯示在配置中。 | 

#### 傳回：
<a name="returns-16"></a>

 Promise。如果拒絕，我們會收到錯誤物件。

 Type   
 Promise \| Promise。<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}> 

### requestResolution（寬度，高度） → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>}
<a name="requestResolution"></a>

 從 Amazon DCV 伺服器請求更新的顯示器解析度。

#### 參數：
<a name="parameters-12"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  width  |  number  |  請求的寬度，以像素為單位。允許的最低值為 0。 | 
|  height  |  number  |  以像素為單位請求的高度。允許的最低值為 0。 | 

#### 傳回：
<a name="returns-17"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise \| Promise。<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}> 

### sendKeyboardEvent(event) → {布林值}
<a name="sendKeyboardEvent"></a>

 傳送鍵盤快速鍵事件。如需鍵盤事件的詳細資訊，請參閱 [ https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent)。有效的鍵盤事件包括：`keypress`、 `keydown`和 `keyup`。如需這些事件的詳細資訊，請參閱 [ https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent\#events](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events)。

#### 參數：
<a name="parameters-13"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  event  |  KeyboardEvent  |  要傳送的鍵盤事件。 | 

#### 傳回：
<a name="returns-18"></a>

 如果事件無效，函數會傳回 `false`。如果事件有效，函數會傳回 `true`。

 Type   
 boolean 

### sendKeyboardShortcut(shortcut) → {void}
<a name="sendKeyboardShortcut"></a>

 傳送鍵盤快速鍵。使用此函數傳送完整 `keydown` 或 `keyup`序列。例如，傳送 Ctrl \+ Alt \+ Del 會傳送`keydown`事件之後所有金鑰`keyup`的事件。即使您想要傳送單一金鑰，也請使用此函數。

#### 參數：
<a name="parameters-14"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  shortcut  |  陣列。<物件>  |  要傳送的金鑰陣列。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  key  |  KeyboardEvent.key  |  使用者按下的金鑰值。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key。 | 
|  location  |  KeyboardEvent.location  |  要傳送的金鑰陣列。鍵盤上金鑰的位置。如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 | 

#### 傳回：
<a name="returns-19"></a>

 Type   
 void 

### setDisplayQuality(min， maxopt) → {void}
<a name="setDisplayQuality"></a>

 設定用於連線的影像品質。有效範圍為 `0`到 `100`，影像品質`1`最低，影像品質`100`最高。指定 `0`以保留目前的值。

#### 參數：
<a name="parameters-15"></a>


|  名稱  |  類型  |  屬性  |  Description  | 
| --- | --- | --- | --- | 
|  min  |  number  |   |  最低影像品質。 | 
|  max  |  number  |  <選用>  |  最高影像品質。 | 

#### 傳回：
<a name="returns-20"></a>

 Type   
 void 

### setDisplayScale(scaleRatio， displayId) → {Promise\|Promise.<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}>} (DEPRECATED)
<a name="setDisplayScale"></a>

 自 1.3.0 版以來已棄用。不再需要設定顯示縮放。滑鼠座標將在內部自動管理。

 通知 Amazon DCV 在用戶端擴展顯示。使用此選項通知伺服器，其需要擴展滑鼠事件以符合用戶端的顯示比例。

#### 參數：
<a name="parameters-16"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  scaleRatio  |  float  |  要使用的擴展比例。必須是嚴格正數。 | 
|  displayId  |  number  |  要擴展的顯示器 ID。 | 

#### 傳回：
<a name="returns-21"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise \| Promise。<{code： [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode)， message： string}> 

### setKeyboardQuirks(quirks) → {void}
<a name="setKeyboardQuirks"></a>

 設定用戶端電腦的鍵盤查詢。

#### 參數：
<a name="parameters-17"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  quirks  |  物件  |  要啟用或停用的鍵盤查詢。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/connection-class.html)  | 
|  macOptionToAlt  |  boolean  |  若要將選項金鑰映射至 macOS 的 Alt，請指定 true。否則請指定 false。 | 
|  macCommandToControl  |  boolean  |  若要將 Command 金鑰映射至 macOS 的 Ctrl，請指定 true。否則請指定 false。 | 

#### 傳回：
<a name="returns-22"></a>

 Type   
 void 

### setMaxDisplayResolution(maxWidth， maxHeight) → {void}
<a name="setMaxDisplayResolution"></a>

 設定用於連線的最大顯示解析度。

#### 參數：
<a name="parameters-18"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  maxWidth  |  number  |  以像素為單位的最大顯示寬度。允許的最低值為 0。 | 
|  maxHeight  |  number  |  以像素為單位的最大顯示高度。允許的最低值為 0。 | 

#### 傳回：
<a name="returns-23"></a>

 Type   
 void 

### setMicrophone（啟用） → {Promise\|Promise.<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}>}
<a name="setMicrophone"></a>

 啟用或停用麥克風。

#### 參數：
<a name="parameters-19"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  若要啟用麥克風，請指定 true。若要停用麥克風，請指定 false。 | 

#### 傳回：
<a name="returns-24"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise \| Promise。<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}> 

### setMinDisplayResolution(minWidth， minHeight) → {void}
<a name="setMinDisplayResolution"></a>

 設定用於連線的最低顯示解析度。有些應用程式可能需要最低的顯示解析度。如果所需的最低解析度大於用戶端支援的最大解析度，則會使用調整大小策略。請仔細使用此函數。調整大小策略可能會導致較不精確的滑鼠和觸控輸入系統。

#### 參數：
<a name="parameters-20"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  minWidth  |  number  |  以像素為單位的最小顯示寬度。允許的最低值為 0。 | 
|  minHeight  |  number  |  以像素為單位的最小顯示高度。允許的最低值為 0。 | 

#### 傳回：
<a name="returns-25"></a>

 Type   
 void 

### setUploadBandwidth（值） → {number}
<a name="setUploadBandwidth"></a>

 設定用於將檔案上傳至 Amazon DCV 伺服器的最大頻寬。

#### 參數：
<a name="parameters-21"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  value  |  number  |  最大頻寬限制，以 kbps 為單位。有效範圍為 1024 kbps 到 102400 kbps。 | 

#### 傳回：
<a name="returns-26"></a>

 - 設定的頻寬限制。`null`如果伺服器上已停用檔案儲存功能。

 Type   
 number 

### setVolume(volume) → {void}
<a name="setVolume"></a>

 設定用於音訊的磁碟區層級。有效範圍為 0 到 100，0 為最低磁碟區，100 為最高磁碟區。

#### 參數：
<a name="parameters-22"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  volume  |  number  |  要使用的磁碟區層級。 | 

#### 傳回：
<a name="returns-27"></a>

 Type   
 void 

### setMicrophone（啟用， deviceId) → {Promise\|Promise.<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}>}
<a name="setMicrophone"></a>

 【實驗性 - 未來可能會變更】 啟用或停用麥克風。

#### 參數：
<a name="parameters-23"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  若要啟用麥克風，請指定 true。若要停用麥克風，請指定 false。 | 
|  deviceId  |  string  |  麥克風的裝置 ID。如果未提供 deviceId，則會使用 default deviceId。 | 

#### 傳回：
<a name="returns-28"></a>

 Promise。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise \| Promise。<{code： [AudioErrorCode](dcv-module.md#AudioErrorCode)， message： string}> 

### setWebcam（啟用， deviceId) → {Promise\|Promise.<{code： [WebcamErrorCode](dcv-module.md#WebcamErrorCode)， message： string}>}
<a name="setWebcam"></a>

 啟用或停用網路攝影機。

#### 參數：
<a name="parameters-23"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enable  |  boolean  |  若要啟用網路攝影機，請指定 true。若要停用網路攝影機，請指定 false。 | 
|  deviceId  |  string  |  網路攝影機的裝置 ID。 | 

#### 傳回：
<a name="returns-28"></a>

 承諾如果成功， 會解析為已連接/已移除的網路攝影機 deviceId。如果拒絕，承諾會傳回錯誤物件。

 Type   
 Promise.<string> \| Promise.<{code： [WebcamErrorCode](dcv-module.md#WebcamErrorCode)， message： string}> 

### syncClipboards() → {布林值}
<a name="syncClipboards"></a>

 同步本機用戶端剪貼簿與遠端 Amazon DCV 伺服器剪貼簿。瀏覽器必須支援自動複製。

#### 傳回：
<a name="returns-29"></a>

 如果剪貼簿已同步，函數會傳回 `true`。如果剪貼簿尚未同步，或瀏覽器不支援自動複製，則函數會傳回 `false`。

 Type   
 boolean