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

# DCV 模組
<a name="dcv-module"></a>

實作 DCV 通訊協定用戶端的模組。

**Topics**
+ [方法](#methods)
+ [成員](#members)
+ [輸入和回呼定義](#type-definitions)

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

**Topics**
+ [authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1](#authenticate)
+ [connect(config) → \$1Promise.<[Connection](connection-class.md)>\$1Promise.<\$1code： [ConnectionErrorCode](#ConnectionErrorCode)， message： string\$1>\$1](#connect)
+ [setLogHandler(handler) → \$1void\$1](#setLogHandler)
+ [setLogLevel(level) → \$1void\$1](#setLogLevel)

### authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1
<a name="authenticate"></a>

 啟動指定 Amazon DCV 伺服器端點的身分驗證程序。

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  url  |  string  |  執行中 Amazon DCV 伺服器的主機名稱和連接埠，格式如下：https://dcv\$1host\$1address:port。例如：https://my-dcv-server:8443。 | 
|  authenticationToken  |  string  |  用於身分驗證的身分驗證字符。 | 
|  callbacks  |  [authenticationCallbacks](#authenticationCallbacks)  |  可在身分驗證程序期間呼叫的回呼。 | 

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

 - 身分驗證物件。

 Type   
 [身分驗證](authentication-class.md) 

### connect(config) → \$1Promise.<[Connection](connection-class.md)>\$1Promise.<\$1code： [ConnectionErrorCode](#ConnectionErrorCode)， message： string\$1>\$1
<a name="connect"></a>

 連線至指定的 Amazon DCV 伺服器端點。如果連線成功，它會傳回連線物件。如果連線失敗，它會傳回錯誤物件。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  config  |  [ConnectionConfig](#ConnectionConfig)  |  ConnectionConfig 物件。 | 

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

 - 連線物件或錯誤物件。

 Type   
 Promise。<[Connection](connection-class.md)> \$1 Promise.<\$1code： [ConnectionErrorCode](#ConnectionErrorCode)， message： string\$1> 

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

 設定自訂日誌處理常式函數。覆寫預設日誌處理常式時，使用瀏覽器主控台進行偵錯時，原始日誌項目位置將會遺失。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  handler  |  函數  |  自訂日誌處理常式函數。處理常式函數包含關卡 (number)、levelName (string)、網域 (string) 和訊息 (string)。 | 

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

 Type   
 void 

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

 設定日誌層級。只有在使用預設日誌處理常式時，才需要這樣做。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  level  |  [LogLevel](#LogLevel)  |  欲使用的日誌層級。 | 

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

 Type   
 void 

## 成員
<a name="members"></a>

**Topics**
+ [（常數） AudioError ：[AudioErrorCode](#AudioErrorCode)](#AudioError)
+ [（常數） AuthenticationError ：[AuthenticationErrorCode](#AuthenticationErrorCode)](#AuthenticationError)
+ [（常數） ChannelError ：[ChannelErrorCode](#ChannelErrorCode)](#ChannelError)
+ [（常數） ClosingReasonError ：[ClosingReasonErrorCode](#ClosingReasonErrorCode)](#ClosingReasonError)
+ [（常數） ConnectionError ：[ConnectionErrorCode](#ConnectionErrorCode)](#ConnectionError)
+ [（常數） CustomChannelError ：[CustomChannelErrorCode](#CustomChannelErrorCode)](#CustomChannelError)
+ [（常數） DisplayConfigError ：[DisplayConfigErrorCode](#DisplayConfigErrorCode)](#DisplayConfigError)
+ [（常數） FileStorageError ：[FileStorageErrorCode](#FileStorageErrorCode)](#FileStorageError)
+ [（常數） LogLevel：[LogLevel](#LogLevel)](#LogLevel_)
+ [（常數） MultiMonitorError ：[MultiMonitorErrorCode](#MultiMonitorErrorCode)](#MultiMonitorError)
+ [（常數） ResolutionError ：[ResolutionErrorCode](#ResolutionErrorCode)](#ResolutionError)
+ [（常數） TimezoneRedirectionError ：[TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)](#TimezoneRedirectionError)
+ [（常數） TimezoneRedirectionSetting ：[TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)](#TimezoneRedirectionSetting)
+ [（常數） TimezoneRedirectionStatus ：[TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)](#TimezoneRedirectionStatus)
+ [（常數） 版本](#version)
+ [（常數） ScreenshotError：[ScreenshotErrorCode](#ScreenshotErrorCode)](#ScreenshotError)
+ [（常數） WebcamError ：[WebcamErrorCode](#WebcamErrorCode)](#WebcamError)

### （常數） AudioError ：[AudioErrorCode](#AudioErrorCode)
<a name="AudioError"></a>

 AudioError 代碼列舉。

#### 類型：
<a name="type"></a>
+  [AudioErrorCode](#AudioErrorCode) 

### （常數） AuthenticationError ：[AuthenticationErrorCode](#AuthenticationErrorCode)
<a name="AuthenticationError"></a>

 AuthenticationError 代碼列舉。

#### 類型：
<a name="type-1"></a>
+  [AuthenticationErrorCode](#AuthenticationErrorCode) 

### （常數） ChannelError ：[ChannelErrorCode](#ChannelErrorCode)
<a name="ChannelError"></a>

 ChannelError 代碼列舉。

#### 類型：
<a name="type-2"></a>
+  [ChannelErrorCode](#ChannelErrorCode) 

### （常數） ClosingReasonError ：[ClosingReasonErrorCode](#ClosingReasonErrorCode)
<a name="ClosingReasonError"></a>

 ClosingReasonError 代碼列舉。

#### 類型：
<a name="type-3"></a>
+  [ClosingReasonErrorCode](#ClosingReasonErrorCode) 

### （常數） ConnectionError ：[ConnectionErrorCode](#ConnectionErrorCode)
<a name="ConnectionError"></a>

 ConnectionError 代碼列舉。

#### 類型：
<a name="type-4"></a>
+  [ConnectionErrorCode](#ConnectionErrorCode) 

### （常數） CustomChannelError ：[CustomChannelErrorCode](#CustomChannelErrorCode)
<a name="CustomChannelError"></a>

 CustomChannelError 代碼列舉。

#### 類型：
<a name="type-5"></a>
+  [CustomChannelErrorCode](#CustomChannelErrorCode) 

### （常數） DisplayConfigError ：[DisplayConfigErrorCode](#DisplayConfigErrorCode)
<a name="DisplayConfigError"></a>

 DisplayConfigError 代碼列舉。

#### 類型：
<a name="type-8"></a>
+  [DisplayConfigErrorCode](#DisplayConfigErrorCode) 

### （常數） FileStorageError ：[FileStorageErrorCode](#FileStorageErrorCode)
<a name="FileStorageError"></a>

 FileStorageError 代碼列舉。

#### 類型：
<a name="type-6"></a>
+  [FileStorageErrorCode](#FileStorageErrorCode) 

### （常數） LogLevel：[LogLevel](#LogLevel)
<a name="LogLevel_"></a>

 可用的 SDK 日誌層級。

#### 類型：
<a name="type-31"></a>
+  [LogLevel](#LogLevel) 

### （常數） MultiMonitorError ：[MultiMonitorErrorCode](#MultiMonitorErrorCode)
<a name="MultiMonitorError"></a>

 MultiMonitorError 代碼列舉。

#### 類型：
<a name="type-7"></a>
+  [MultiMonitorErrorCode](#MultiMonitorErrorCode) 

### （常數） ResolutionError ：[ResolutionErrorCode](#ResolutionErrorCode)
<a name="ResolutionError"></a>

 ResolutionError 代碼列舉。

#### 類型：
<a name="w2aac14b9c13c25b5"></a>
+  [ResolutionErrorCode](#ResolutionErrorCode) 

### （常數） TimezoneRedirectionError ：[TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)
<a name="TimezoneRedirectionError"></a>

 TimezoneRedirectionError 代碼列舉。

#### 類型：
<a name="w2aac14b9c13c27b5"></a>
+  [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) 

### （常數） TimezoneRedirectionSetting ：[TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)
<a name="TimezoneRedirectionSetting"></a>

 TimezoneRedirectionSetting 代碼列舉。

#### 類型：
<a name="w2aac14b9c13c29b5"></a>
+  [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) 

### （常數） TimezoneRedirectionStatus ：[TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)
<a name="TimezoneRedirectionStatus"></a>

 TimezoneRedirectionStatus 代碼列舉。

#### 類型：
<a name="w2aac14b9c13c31b5"></a>
+  [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) 

### （常數） 版本
<a name="version"></a>

 具有主要、次要、修補程式、修訂、延伸和 versionStr 的 Amazon DCV 版本。

#### 屬性：
<a name="properties"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  major  |  integer  |  主要版本編號。 | 
|  minor  |  integer  |  次要版本編號。 | 
|  patch  |  integer  |  修補程式版本編號。 | 
|  revision  |  integer  |  修訂編號。 | 
|  extended  |  string  |  延伸字串。 | 
|  versionStr  |  string  |  以 形式串連主要、次要、修補程式和修訂編號major.minor.patch\$1build.revision。 | 

### （常數） ScreenshotError：[ScreenshotErrorCode](#ScreenshotErrorCode)
<a name="ScreenshotError"></a>

 ScreenshotError 程式碼列舉。

#### 類型：
<a name="type-34"></a>
+  [ScreenshotErrorCode](#ScreenshotErrorCode) 

### （常數） WebcamError ：[WebcamErrorCode](#WebcamErrorCode)
<a name="WebcamError"></a>

 WebcamError碼列舉。

#### 類型：
<a name="type-9"></a>
+  [WebcamErrorCode](#WebcamErrorCode) 

## 輸入和回呼定義
<a name="type-definitions"></a>

**Topics**
+ [AudioErrorCode](#AudioErrorCode)
+ [authenticationCallbacks](#authenticationCallbacks)
+ [AuthenticationErrorCode](#AuthenticationErrorCode)
+ [authErrorCallback（身分驗證、錯誤）](#authErrorCallback)
+ [authPromptCredentialsCallback （身分驗證、挑戰）](#authPromptCredentialsCallback)
+ [authSuccessCallback（身分驗證、身分authenticationData)](#authSuccessCallback)
+ [Channel](#Channel)
+ [ChannelErrorCode](#ChannelErrorCode)
+ [clipboardEventCallback（事件）](#clipboardEventCallback)
+ [ClosingReasonErrorCode](#ClosingReasonErrorCode)
+ [色彩空間](#Colorspace)
+ [connectionCallbacks](#connectionCallbacks)
+ [ConnectionConfig](#ConnectionConfig)
+ [ConnectionErrorCode](#ConnectionErrorCode)
+ [createDirectory（路徑）](#createDirectory)
+ [CustomChannelErrorCode](#CustomChannelErrorCode)
+ [dataChannelCallback（資訊）](#dataChannelCallback)
+ [deleteFile（路徑）](#deleteFile)
+ [deviceChangeEventCallback()](#deviceChangeEventCallback)
+ [disconnectCallback（原因）](#disconnectCallback)
+ [displayAvailabilityCallback（狀態，displayId)](#displayAvailabilityCallback)
+ [DisplayConfigErrorCode](#DisplayConfigErrorCode)
+ [displayLayoutCallback(serverWidth、serverHeight、heads)](#displayLayoutCallback)
+ [功能](#feature)
+ [featuresUpdateCallback(featuresList)](#featuresUpdateCallback)
+ [fileDownloadCallback(fileResource)](#fileDownloadCallback)
+ [filePrintedCallback(printResource)](#filePrintedCallback)
+ [檔案儲存](#filestorage)
+ [filestorageEnabledCallback（已啟用）](#filestorageEnabledCallback)
+ [FileStorageErrorCode](#FileStorageErrorCode)
+ [firstFrameCallback(resizeEnabled， relativeMouseModeEnabled， displayId)](#firstFrameCallback)
+ [idleWarningNotificationCallback(disconnectionDateTime)](#idleWarningNotificationCallback)
+ [collaboratorListCallback（協作者）](#collaboratorListCallback)
+ [licenseNotificationCallback（通知）](#licenseNotificationCallback)
+ [list（路徑）](#list)
+ [LogLevel](#LogLevel)
+ [監控](#Monitor)
+ [MultiMonitorErrorCode](#MultiMonitorErrorCode)
+ [qualityIndicatorStateCallback（狀態）](#qualityIndicatorStateCallback)
+ [renameDirectory(src， dest)](#renameDirectory)
+ [renameFile(src， dest)](#renameFile)
+ [ResolutionErrorCode](#ResolutionErrorCode)
+ [retrieveFile（路徑）](#retrieveFile)
+ [screenshotCallback（螢幕擷取畫面）](#screenshotCallback)
+ [ScreenshotErrorCode](#ScreenshotErrorCode)
+ [serverInfo](#serverInfo)
+ [統計資料](#stats)
+ [storeFile(file， dir)](#storeFile)
+ [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode)
+ [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode)
+ [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode)
+ [WebcamErrorCode](#WebcamErrorCode)
+ [httpExtraSearchParamsCallback（方法、url、內文）](#httpExtraSearchParamsCallback)
+ [httpExtraHeadersCallback（方法、url、內文）](#httpExtraHeadersCallback)

### AudioErrorCode
<a name="AudioErrorCode"></a>

 DCV 模組中可用的 AudioError 程式碼列舉 
+  `SETTING_AUDIO_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### 類型：
<a name="type-10"></a>
+  number 

### authenticationCallbacks
<a name="authenticationCallbacks"></a>

 身分驗證回呼 

#### 類型：
<a name="type-11"></a>
+  物件 

#### 屬性：
<a name="properties-1"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  promptCredentials  |  [authPromptCredentialsCallback](#authPromptCredentialsCallback)  |  當使用者受到憑證挑戰時要呼叫的回呼函數。 | 
|  error  |  [authErrorCallback](#authErrorCallback)  |  身分驗證失敗時要呼叫的回呼函數。 | 
|  success  |  [authSuccessCallback](#authSuccessCallback)  |  身分驗證成功時要呼叫的回呼函數。 | 
|  httpExtraSearchParamsCallback  |  [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback)  |  authenticate 方法中要呼叫的回呼函數，用於在啟動請求之前將自訂查詢參數插入身分驗證 URL。它也可以用於 connect方法，以自訂在建立與 DCV 伺服器的 WebSocket 連線時所使用的 URL。 | 

### AuthenticationErrorCode
<a name="AuthenticationErrorCode"></a>

 DCV 模組中可用的 AuthenticationError 程式碼列舉 
+  `INVALID_MESSAGE` 
+  `UNKNOWN_AUTH_MODE` 
+  `SESSION_NOT_AVAILABLE` 
+  `NO_SESSIONS` 
+  `WRONG_CREDENTIALS` 
+  `SASL_CHALLENGE` 
+  `SASL_AUTH_MECHANISM` 
+  `FAILED_COMMUNICATION` 
+  `AUTHENTICATION_REJECTED` 
+  `GENERIC_ERROR` 
+  `WRONG_CREDENTIALS_FORMAT` 
+  `WRONG_CREDENTIALS_TYPE` 
+  `UNREQUESTED_CREDENTIALS` 
+  `MISSING_CREDENTIAL` 

#### 類型：
<a name="type-12"></a>
+  number 

### authErrorCallback（身分驗證、錯誤）
<a name="authErrorCallback"></a>

 驗證失敗時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  authentication  |  [身分驗證](authentication-class.md)  |  身分驗證物件。 | 
|  error  |  物件  |  身分驗證程序引發的錯誤物件。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  [AuthenticationErrorCode](#AuthenticationErrorCode)  |  錯誤代碼。 | 
|  message  |  string  |  錯誤訊息。 | 

### authPromptCredentialsCallback （身分驗證、挑戰）
<a name="authPromptCredentialsCallback"></a>

 當使用者受到憑證挑戰時要呼叫的回呼函數。使用者必須提供請求的登入資料來回答挑戰。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  authentication  |  [身分驗證](authentication-class.md)  |  身分驗證物件。 | 
|  challenge  |  物件  |  挑戰。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  requiredCredentials  |  陣列。<物件>  |  請求的登入資料物件陣列。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  string  |  請求的登入資料名稱。 | 
|  type  |  string  |  請求的登入資料的類型。 | 

### authSuccessCallback（身分驗證、身分authenticationData)
<a name="authSuccessCallback"></a>

 身分驗證成功時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  authentication  |  [身分驗證](authentication-class.md)  |  身分驗證物件。 | 
|  authenticationData  |  陣列。<物件>  |  包含 Amazon DCV 工作階段 IDs和身分驗證字符的物件陣列。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  sessionId  |  string  |  Amazon DCV 工作階段 ID。 | 
|  authToken  |  string  |  Amazon DCV 工作階段的身分驗證字符。 | 

### Channel
<a name="Channel"></a>

 可指定的可用頻道。

#### 類型：
<a name="type-13"></a>
+  "剪貼簿" \$1 "display" \$1 "input" \$1 "audio" \$1 "filestorage"

### ChannelErrorCode
<a name="ChannelErrorCode"></a>

 DCV 模組中可用的 ChannelError 程式碼列舉 
+  `ALREADY_OPEN` 
+  `INITIALIZATION_FAILED` 
+  `REJECTED` 

#### 類型：
<a name="type-14"></a>
+  number 

### clipboardEventCallback（事件）
<a name="clipboardEventCallback"></a>

 產生 時要呼叫`clipboardEvent`的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  屬性  |  Description  | 
| --- | --- | --- | --- | 
|  event  |  物件  |  剪貼簿事件的相關資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  已建立 \$1 複製 \$1 貼上 \$1 dataSizeAlert \$1 autoCopyDone \$1 newDataAvailable \$1 autoPasteDone \$1 remoteError \$1 pasteAvailableData  |   |  永遠存在。事件的名稱。 | 
|  clipboardData  |  物件 \$1 字串  |   |  剪貼簿中的資料。 | 
|  autoCopy  |  boolean  |  <選用>  |  指出是否已啟用從工作階段剪貼簿自動複製到本機用戶端剪貼簿。 | 
|  maxDataSize  |  number  |  <選用>  |  可放置在剪貼簿中的資料量上限。 | 
|  error  |  string  |  <選用>  |  適用時的錯誤資訊。 | 

### ClosingReasonErrorCode
<a name="ClosingReasonErrorCode"></a>

 DCV 模組中可用的 ClosingReasonError 程式碼列舉 
+  `TRANSPORT_ERROR` 
+  `NO_ERROR` 
+  `GENERIC_ERROR` 
+  `INTERNAL_SERVER_ERROR` 
+  `PROTOCOL_ERROR` 
+  `AUTHORIZATION_DENIED` 
+  `AUTHORIZATION_REVOKED` 
+  `ACCESS_REJECTED` 
+  `IDLE_TIMEOUT_EXPIRED` 
+  `DISCONNECT_BY_OWNER` 
+  `DISCONNECT_BY_USER` 
+  `EVICTED` 
+  `EXTERNAL_PROTOCOL_CONNECTION_EVICTED` 
+  `DISCONNECTION_REQUESTED` 

#### 類型：
<a name="type-15"></a>
+  number 

### 色彩空間
<a name="Colorspace"></a>

 可指定的可用色彩空間。

#### 類型：
<a name="type-16"></a>
+  "RGB" \$1 "YUV\$1REC601" \$1 "YUV\$1REC709"

### connectionCallbacks
<a name="connectionCallbacks"></a>

 發生連線錯誤時可呼叫的回呼。

#### 類型：
<a name="type-17"></a>
+  物件 

#### 屬性：
<a name="properties-7"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  disconnect  |  [disconnectCallback](#disconnectCallback)  |  連線結束時要呼叫的回呼函數。 | 
|  displayLayout  |  [displayLayoutCallback](#displayLayoutCallback)  |  變更顯示配置或解析度時要呼叫的回呼函數。 | 
|  displayAvailability  |  [displayAvailabilityCallback](#displayAvailabilityCallback)  |  顯示可用性變更時要呼叫的回呼函數。 | 
|  firstFrame  |  [firstFrameCallback](#firstFrameCallback)  |  從 Amazon DCV 伺服器接收第一個影格時要呼叫的回呼函數。 | 
|  filePrinted  |  [filePrintedCallback](#filePrintedCallback)  |  在 Amazon DCV 伺服器上列印檔案時要呼叫的回呼函數。 | 
|  fileDownload  |  [fileDownloadCallback](#fileDownloadCallback)  |  準備好從 Amazon DCV 伺服器下載檔案時要呼叫的回呼函數。 | 
|  dataChannel  |  [dataChannelCallback](#dataChannelCallback)  |  當 Amazon DCV 伺服器傳送有關資料通道可用性的通知時，要呼叫的回呼函數。 | 
|  licenseNotification  |  [licenseNotificationCallback](#licenseNotificationCallback)  |  當 Amazon DCV 伺服器傳送授權狀態的通知時，要呼叫的回呼函數。 | 
|  idleWarningNotification  |  [idleWarningNotificationCallback](#idleWarningNotificationCallback)  |  Amazon DCV 伺服器傳送閒置逾時警告時要呼叫的回呼函數。 | 
|  collaboratorList  |  [collaboratorListCallback](#collaboratorListCallback)  |  Amazon DCV 伺服器傳送協作者清單時要呼叫的回呼函數 （自 Amazon DCV Web 用戶端 SDK 1.1.0 版起）。 | 
|  qualityIndicatorState  |  [qualityIndicatorStateCallback](#qualityIndicatorStateCallback)  |  當連線品質指標變更狀態時要呼叫的回呼函數。 | 
|  filestorageEnabled  |  [filestorageEnabledCallback](#filestorageEnabledCallback)  |  啟用或停用檔案儲存時要呼叫的回呼函數。 | 
|  featuresUpdate  |  [featuresUpdateCallback](#featuresUpdateCallback)  |  當功能的狀態變更時要呼叫的回呼函數。 | 
|  clipboardEvent  |  [clipboardEventCallback](#clipboardEventCallback)  |  產生 時要呼叫clipboardEvent的回呼函數。 | 
|  deviceChangeEvent  |  [deviceChangeEventCallback](#deviceChangeEventCallback)  |  觸發deviceChange事件時要呼叫的回呼函數。 | 
|  screenshot  |  [screenshotCallback](#screenshotCallback)  |  當 screenshot可用時要呼叫的回呼函數。 | 
|  httpExtraSearchParamsCallback  |  [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback)  |  建立與 Amazon DCV 伺服器的 WebSocket 連線時，要呼叫以自訂 URL 的回呼函數。請注意，此回呼也可以與 authenticate方法搭配使用，以在 SDK 傳送請求之前，將查詢參數動態附加至身分驗證 URL。 | 
|  httpExtraHeadersCallback  |  [httpExtraHeadersCallback](#httpExtraHeadersCallback)  |  要在建立連線期間將自訂標頭新增至 HTTP 請求時呼叫的回呼函數。 | 

### ConnectionConfig
<a name="ConnectionConfig"></a>

 Amazon DCV 連線的組態。

#### 類型：
<a name="type-18"></a>
+  物件 

#### 屬性：
<a name="properties-8"></a>


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  url  |  string  |  執行中 Amazon DCV 伺服器的主機名稱和連接埠，格式如下：https://dcv\$1host\$1address:port。例如：https://my-dcv-server:8443。 | 
|  sessionId  |  string  |  Amazon DCV 工作階段 ID。 | 
|  authToken  |  string  |  連線至伺服器時要使用的身分驗證字符。 | 
|  baseUrl  |  string  |  要從中載入 SDK 檔案的絕對或相對 URL。 | 
|  resourceBaseUrl  |  string  |  存取 DCV 資源的絕對或相對 URL。 | 
|  enabledChannels  |  陣列。<[頻道](#Channel)>  |  指出可啟用的頻道清單。如果未指定或提供空白陣列，則預設為所有可用的頻道。 | 
|  losslessColorspace  |  [色彩空間](#Colorspace)  |  指出將使用的色彩空間。如果未指定，則預設為 "RGB"。 | 
|  divId  |  string  |  HTML DOM 中的div物件 ID，其中 SDK 應使用遠端串流建立畫布。 | 
|  volumeLevel  |  integer  |  偏好的磁碟區層級。有效範圍為 0 到 100。 | 
|  clipboardAutoSync  |  boolean  |  指出是否針對相容的 Web 瀏覽器啟用從 Amazon DCV 工作階段剪貼簿自動複製到本機用戶端剪貼簿。 | 
|  dynamicAudioTuning  |  boolean  |  指出是否在建立連線時，根據 Amazon DCV 伺服器音訊設定動態調整音訊。 | 
|  clientHiDpiScaling  |  boolean  |  指出是否根據用戶端的 DPI 擴展畫布。 | 
|  highColorAccuracy  |  boolean  |  指出如果可用，是否應使用高顏色準確度。如果未指定，則預設為 false。 | 
|  enableWebCodecs  |  Boolean  |  指出是否應使用 WebCodecs。如果未指定，則預設為 false。 | 
|  observers  |  [connectionCallbacks](#connectionCallbacks)  |  要針對與連線相關的事件呼叫的回呼函數。 | 
|  callbacks  |  [connectionCallbacks](#connectionCallbacks)  |  與 observers 屬性相同，但每個回呼都包含 [Connection](connection-class.md) 物件做為第一個參數。 | 

### ConnectionErrorCode
<a name="ConnectionErrorCode"></a>

 DCV 模組中可用的 ConnectionError 程式碼列舉 
+  `ALREADY_OPEN` 
+  `INVALID_CONFIG` 
+  `INITIALIZATION_FAILED` 
+  `REJECTED` 
+  `MAIN_CHANNEL_ALREADY_OPEN` 
+  `GENERIC_ERROR` （自 DCV Server 2021.0 起） 
+  `INTERNAL_SERVER_ERROR` （自 DCV Server 2021.0 起） 
+  `AUTHENTICATION_FAILED` （自 DCV Server 2021.0 起） 
+  `PROTOCOL_ERROR` （自 DCV Server 2021.0 起） 
+  `INVALID_SESSION_ID` （自 DCV Server 2021.0 起） 
+  `INVALID_CONNECTION_ID` （自 DCV Server 2021.0 起） 
+  `CONNECTION_LIMIT_REACHED` （自 DCV Server 2021.0 起） 
+  `SERVER_UNREACHABLE` （自 DCV Server 2022.1 起） 
+  `GATEWAY_BUSY` 
+  `UNSUPPORTED_CREDENTIAL` （自 DCV Server 2022.2 起） 
+  `TRANSPORT_ERROR` 

#### 類型：
<a name="type-19"></a>
+  number 

### createDirectory（路徑）
<a name="createDirectory"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  path  |  string  |  伺服器上要建立目錄的絕對路徑。它還應該包含目標目錄的名稱。 | 

### CustomChannelErrorCode
<a name="CustomChannelErrorCode"></a>

 DCV 模組中可用的 CustomChannelError 程式碼列舉 
+  `TRANSPORT_ERROR` 

#### 類型：
<a name="type-20"></a>
+  number 

### dataChannelCallback（資訊）
<a name="dataChannelCallback"></a>

 當 Amazon DCV 伺服器傳送有關資料通道可用性的通知時，要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  info  |  物件  |  有關資料頻道的資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  string  |  資料通道的名稱。 | 
|  token  |  string  |  資料通道的身分驗證字符。 | 

### deleteFile（路徑）
<a name="deleteFile"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  path  |  string  |  伺服器上識別我們要刪除之檔案的絕對路徑。 | 

### deviceChangeEventCallback()
<a name="deviceChangeEventCallback"></a>

 觸發`deviceChange`事件時要呼叫的回呼函數。

### disconnectCallback（原因）
<a name="disconnectCallback"></a>

 連線結束時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  reason  |  物件  |  中斷連線的原因。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  code  |  number  |  原因代碼。 | 
|  message  |  string  |  原因訊息。 | 

### displayAvailabilityCallback（狀態，displayId)
<a name="displayAvailabilityCallback"></a>

 顯示可用性變更時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  status  |  物件  |  顯示的狀態。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  displayId  |  number  |  顯示的識別符。 | 
|  enabled  |  boolean  |  指出是否已啟用顯示。 | 
|  closed  |  boolean  |  指出顯示是否關閉。 | 

### DisplayConfigErrorCode
<a name="DisplayConfigErrorCode"></a>

 DCV 模組中可用的 DisplayConfigError 程式碼列舉 
+  `INVALID_ARGUMENT` 
+  `UNSUPPORTED_OPERATION` 
+  `NO_CHANNEL` 

#### 類型：
<a name="type-32"></a>
+  number 

### displayLayoutCallback(serverWidth、serverHeight、heads)
<a name="displayLayoutCallback"></a>

 變更顯示配置或解析度時要呼叫的回呼函數。

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


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  serverWidth  |  number  |  主要顯示器的寬度 （以像素為單位）。 | 
|  serverHeight  |  number  |  主要顯示器的高度 （以像素為單位）。 | 
|  heads  |  陣列。<[Monitor](#Monitor)>  |  Amazon DCV 伺服器支援的顯示頭。 | 

### 功能
<a name="feature"></a>

 功能值。
+  `display` - 指出單一顯示器視訊串流的可用性。
+  `display-multi` - 指出多顯示器視訊串流的可用性。
+  `high-color-accuracy` - 指出高色彩準確性的可用性 （自 Amazon DCV Web 用戶端 SDK 1.1.0 版起）。
+  `mouse` - 指出滑鼠功能的可用性。
+  `keyboard` - 指出鍵盤功能的可用性。
+  `keyboard-sas` - 指出 SAS 序列 （控制 \$1 Alt \$1 刪除） 功能的可用性。
+  `relative-mouse` - 指出相對滑鼠模式的可用性。
+  `clipboard-copy` - 指出從 Amazon DCV 伺服器到用戶端的剪貼簿複製功能可用性。
+  `clipboard-paste` - 指出從用戶端到 Amazon DCV 伺服器的剪貼簿貼圖功能可用性。
+  `audio-in` - 表示使用麥克風提供音訊輸入功能。
+  `audio-out` - 指出音訊播放功能的可用性。
+  `webcam` - 指出網路攝影機串流功能的可用性。
+  `file-download` - 指出檔案下載功能從 Amazon DCV 伺服器到用戶端的可用性。
+  `file-upload` - 指出從用戶端到 Amazon DCV 伺服器的檔案上傳功能的可用性。
+  `timezone-redirection` - 指出時區重新導向功能的可用性 （自 Amazon DCV Web 用戶端 SDK 1.3.0 版起）。

#### 類型：
<a name="type-21"></a>
+  string 

### featuresUpdateCallback(featuresList)
<a name="featuresUpdateCallback"></a>

 當功能的狀態變更時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  featuresList  |  Array.<[feature](#feature)>  |  已變更的功能陣列。 | 

### fileDownloadCallback(fileResource)
<a name="fileDownloadCallback"></a>

 準備好從 Amazon DCV 伺服器下載檔案時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  fileResource  |  物件  |  已準備好下載之檔案的相關資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  id  |  string  |  檔案的識別符。 | 
|  url  |  string  |  用來下載檔案的 URL。 | 
|  domain  |  string  |  資源網域。 | 
|  token  |  string  |  用來下載檔案的身分驗證字符。權杖也包含在 URL 中。 | 

### filePrintedCallback(printResource)
<a name="filePrintedCallback"></a>

 在 Amazon DCV 伺服器上列印檔案時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  printResource  |  物件  |  列印檔案的相關資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  id  |  string  |  列印檔案的識別符。 | 
|  url  |  string  |  用來下載列印檔案的 URL。 | 
|  domain  |  string  |  資源網域。在這種情況下， printer。 | 
|  token  |  string  |  用來下載列印檔案的身分驗證字符。權杖也包含在 URL 中。 | 

### 檔案儲存
<a name="filestorage"></a>

 允許在檔案系統上探索和執行動作的物件。

#### 類型：
<a name="type-22"></a>
+  物件 

#### 屬性：
<a name="properties-14"></a>


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  list  |  [清單](#list)  |  允許 列出存在於伺服器上所提供路徑的項目 （檔案和目錄） 的函數。 | 
|  createDirectory  |  [createDirectory](#createDirectory)  |  允許 在伺服器上指定路徑建立目錄的 函數。 | 
|  retrieveFile  |  [retrieveFile](#retrieveFile)  |  允許 在伺服器指定路徑本機下載檔案的 函數。 | 
|  deleteFile  |  [deleteFile](#deleteFile)  |  允許 在伺服器上指定路徑刪除檔案的 函數。 | 
|  renameFile  |  [renameFile](#renameFile)  |  允許 將檔案從指定的來源路徑重新命名為指定目的地路徑的 函數。 | 
|  renameDirectory  |  [renameDirectory](#renameDirectory)  |  允許 將目錄從指定的來源路徑重新命名為絕對目的地路徑的函數。 | 
|  storeFile  |  [storeFile](#storeFile)  |  允許 將本機檔案上傳至伺服器上所提供路徑的 函數。 | 

### filestorageEnabledCallback（已啟用）
<a name="filestorageEnabledCallback"></a>

 啟用檔案儲存時要呼叫的回呼函數。僅限 Internet Explorer 11 上的延遲頻道。

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


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  enabled  |  boolean  |  指出是否啟用檔案儲存。 | 

### FileStorageErrorCode
<a name="FileStorageErrorCode"></a>

 DCV 模組中可用的 FileStorageError 程式碼列舉 
+  `CANCELLED` 
+  `ABORTED` 
+  `INVALID_ARGUMENT` 
+  `NOT_IMPLEMENTED` 
+  `ERROR` 
+  `ALREADY_EXIST` 
+  `NOT_FOUND` 

#### 類型：
<a name="type-23"></a>
+  number 

### firstFrameCallback(resizeEnabled， relativeMouseModeEnabled， displayId)
<a name="firstFrameCallback"></a>

 從 Amazon DCV 伺服器接收第一個影格時要呼叫的回呼函數。為每個顯示器發出。

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


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  resizeEnabled  |  boolean  |  指出伺服器是否支援調整用戶端顯示配置的大小。 | 
|  relativeMouseModeEnabled  |  boolean  |  指出伺服器是否支援相對滑鼠模式。 | 
|  displayId  |  number  |  顯示的識別符。 | 

### idleWarningNotificationCallback(disconnectionDateTime)
<a name="idleWarningNotificationCallback"></a>

 Amazon DCV 伺服器傳送閒置逾時警告時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  disconnectionDateTime  |  Date  |  中斷連線的日期和時間。 | 

### collaboratorListCallback（協作者）
<a name="collaboratorListCallback"></a>

 Amazon DCV 伺服器傳送協作器清單時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  collaborators  |  陣列。<物件>  |  包含協作者相關資訊的物件清單。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  username  |  string  |  協作者的使用者名稱。 | 
|  owner  |  boolean  |  指出協作者是否為工作階段擁有者。 | 
|  connectionId  |  number  |  指出伺服器指派給連線的 ID。 | 

### licenseNotificationCallback（通知）
<a name="licenseNotificationCallback"></a>

 當 Amazon DCV 伺服器傳送授權狀態的通知時，要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  notification  |  物件  |  通知。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  product  |  string  |  DCV 產品。 | 
|  status  |  string  |  授權的狀態。 | 
|  message  |  string  |  訊息。 | 
|  leftDays  |  number  |  授權到期之前的天數。 | 
|  isDemo  |  boolean  |  指出授權是否為示範授權。 | 
|  numUnlicensed  |  number  |  未授權連線的數量。 | 
|  licensingMode  |  string  |  授權模式。 | 
|  documentationUrl  |  string  |  文件的 URL。 | 

### list（路徑）
<a name="list"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  path  |  string  |  伺服器上要列出內容的絕對路徑。 | 

### LogLevel
<a name="LogLevel"></a>

 可用的 SDK 日誌層級。

#### 類型：
<a name="type-24"></a>
+  追蹤 \$1 除錯 \$1 資訊 \$1 警告 \$1 錯誤 \$1 靜音 

### 監控
<a name="Monitor"></a>

#### 類型：
<a name="type-25"></a>
+  物件 

#### 屬性：
<a name="properties-16"></a>


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  name  |  string  |  顯示頭的名稱。 | 
|  rect  |  物件  |  顯示頭的相關資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  primary  |  boolean  |  指出顯示頭是否為主要顯示頭。如果可用，這取決於遠端作業系統。 | 
|  dpi  |  number  |  顯示頭的 DPI。 | 
|  x  |  number  |  顯示頭的初始x座標。 | 
|  y  |  number  |  顯示頭的初始y座標。 | 
|  width  |  number  |  顯示頭的寬度 （以像素為單位）。 | 
|  height  |  number  |  顯示頭的高度 （以像素為單位）。 | 

### MultiMonitorErrorCode
<a name="MultiMonitorErrorCode"></a>

 DCV 模組中可用的 MultiMonitorError 程式碼列舉 
+  `NO_DISPLAY_CHANNEL` 
+  `MAX_DISPLAY_NUMBER_REACHED` 
+  `INVALID_ARGUMENT` 
+  `DISPLAY_NOT_OPENED_BY_SERVER` 
+  `REQUEST_TIMEOUT` 
+  `GENERIC_ERROR` 
+  `NO_ERROR` 

#### 類型：
<a name="type-26"></a>
+  number 

### qualityIndicatorStateCallback（狀態）
<a name="qualityIndicatorStateCallback"></a>

 當連線品質指標變更狀態時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  state  |  陣列。<物件>  |  連線品質的相關資訊。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  name  |  string  |  指標的名稱。 | 
|  status  |  正常 \$1 警告 \$1 嚴重  |  狀態的描述。 | 
|  changed  |  boolean  |  指出狀態是否變更。 | 

### renameDirectory(src， dest)
<a name="renameDirectory"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  src  |  string  |  伺服器上識別要重新命名之目錄的絕對來源路徑。 | 
|  dest  |  string  |  伺服器上指定目標路徑和目錄名稱的絕對目的地路徑。 | 

### renameFile(src， dest)
<a name="renameFile"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  src  |  string  |  伺服器上識別要重新命名之檔案的絕對來源路徑。 | 
|  dest  |  string  |  伺服器上指定目標路徑和檔案名稱的絕對目的地路徑。 | 

### ResolutionErrorCode
<a name="ResolutionErrorCode"></a>

 DCV 模組中可用的 ResolutionError 程式碼列舉 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `NOT_IMPLEMENTED` 

#### 類型：
<a name="type-27"></a>
+  number 

### retrieveFile（路徑）
<a name="retrieveFile"></a>

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  path  |  string  |  伺服器上的絕對路徑，識別要在本機下載的檔案。 | 

### screenshotCallback（螢幕擷取畫面）
<a name="screenshotCallback"></a>

 螢幕擷取畫面可用時要呼叫的回呼函數。

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  screenshot  |  byte[]  |  PNG 格式的螢幕擷取畫面緩衝區，或螢幕擷取失敗null時。 | 

### ScreenshotErrorCode
<a name="ScreenshotErrorCode"></a>

 DCV 模組中可用的 ScreenshotError 程式碼列舉 
+  `NO_CHANNEL` 
+  `GENERIC_ERROR` 

#### 類型：
<a name="type-33"></a>
+  number 

### serverInfo
<a name="serverInfo"></a>

#### 類型：
<a name="type-28"></a>
+  物件 

#### 屬性：
<a name="properties-19"></a>


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  name  |  string  |  軟體的名稱。 | 
|  version  |  物件  |  軟體版本號碼。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-module.html)  | 
|  os  |  string  |  作業系統。 | 
|  arch  |  string  |  架構。 | 
|  hostname  |  string  |  主機名稱。 | 
|  major  |  number  |  主要版本編號。 | 
|  minor  |  number  |  次要版本編號。 | 
|  revision  |  number  |  修訂版本編號。 | 

### 統計資料
<a name="stats"></a>

#### 類型：
<a name="type-29"></a>
+  物件 

#### 屬性：
<a name="properties-21"></a>


|  名稱  |  類型  |  描述  | 
| --- | --- | --- | 
|  fps  |  number  |  目前每秒影格數。 | 
|  traffic  |  number  |  位元/秒的目前流量。 | 
|  peakTraffic  |  number  |  自建立連線以來，以位元/秒為單位的流量峰值。 | 
|  latency  |  number  |  目前延遲，以毫秒為單位。 | 
|  currentChannels  |  number  |  自建立連線以來已開啟的頻道數量。 | 
|  openedChannels  |  number  |  目前開啟的頻道數量。 | 
|  channelErrors  |  number  |  已報告錯誤的頻道數量。 | 

### storeFile(file， dir)
<a name="storeFile"></a>

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


|  名稱  |  類型  |  說明  | 
| --- | --- | --- | 
|  file  |  檔案  |  要上傳至伺服器的檔案物件 （如需詳細資訊，請參閱 https：//https://developer.mozilla.org/en-US/docs/Web/API/File)。 | 
|  dir  |  string  |  伺服器上要上傳檔案的絕對路徑。 | 

### TimezoneRedirectionErrorCode
<a name="TimezoneRedirectionErrorCode"></a>

 DCV 模組中可用的 TimezoneRedirectionError 程式碼列舉 
+  `INVALID_ARGUMENT` 
+  `NO_CHANNEL` 
+  `USER_CANNOT_CHANGE` 

#### 類型：
<a name="w2aac14b9c17d101b7"></a>
+  number 

### TimezoneRedirectionSettingCode
<a name="TimezoneRedirectionSettingCode"></a>

 DCV 模組中可用的 TimezoneRedirectionSetting 程式碼列舉 
+  `ALWAYS_OFF` 
+  `ALWAYS_ON` 
+  `CLIENT_DECIDES` 

#### 類型：
<a name="w2aac14b9c17d103b7"></a>
+  number 

### TimezoneRedirectionStatusCode
<a name="TimezoneRedirectionStatusCode"></a>

 DCV 模組中可用的 TimezoneRedirectionStatus 程式碼列舉 
+  `SUCCESS` 
+  `PERMISSION_ERROR` 
+  `GENERIC_ERROR` 

#### 類型：
<a name="w2aac14b9c17d105b7"></a>
+  number 

### WebcamErrorCode
<a name="WebcamErrorCode"></a>

 DCV 模組中可用的 WebcamError 程式碼列舉 
+  `SETTING_WEBCAM_FAILED` 
+  `CHANNEL_NOT_AVAILABLE` 

#### 類型：
<a name="type-30"></a>
+  number 

### httpExtraSearchParamsCallback（方法、url、內文）
<a name="httpExtraSearchParamsCallback"></a>

 呼叫回呼函數，以在身分驗證和建立連線期間將自訂查詢參數插入 URLs。這可啟用進階整合案例，包括能夠附加自訂查詢參數，以及新增 AWS 簽章第 4 版 (SigV4) 簽章值，以透過外部系統保護和授權連線。

此回呼也用於自訂在建立與 Amazon DCV 伺服器的 WebSocket 連線時所使用的 URL。

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  method  |  string  |  用於請求的 HTTP 方法。 | 
|  url  |  string  |  將用於請求的 URL。 | 
|  body  |  string  |  請求本體的內容。 | 

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

 `URLSearchParams` 物件包含要附加至 URL 的自訂查詢參數。

 Type   
 URLSearchParams 

### httpExtraHeadersCallback（方法、url、內文）
<a name="httpExtraHeadersCallback"></a>

 在建立連線期間，要呼叫以將自訂標頭 （例如 `Authorization`) 插入 HTTP 請求的回呼函數。

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


|  名稱  |  類型  |  Description  | 
| --- | --- | --- | 
|  method  |  string  |  用於請求的 HTTP 方法。 | 
|  url  |  string  |  將用於請求的 URL。 | 
|  body  |  string  |  請求本體的內容。 | 

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

 包含代表要新增至 HTTP 請求之自訂標頭的鍵/值對的物件。

 Type   
 物件