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

# Amazon DCV Web UI SDK
<a name="dcv-viewer"></a>

 JavaScript React 元件程式庫，目前正在匯出名為 的單一 React 元件`DCVViewer`，該元件會連線至 Amazon DCV 伺服器，並轉譯工具列以與遠端串流互動。

**Topics**
+ [元件](#Components)

## 元件
<a name="Components"></a>

**Topics**
+ [DCVViewer](#DCVViewer)

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

 React 元件轉譯工具列及其所有功能，有助於與遠端串流互動。

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

**Topics**
+ [dcv](#dcv-prop)
+ [uiConfig](#uiConfig-prop)

##### dcv
<a name="dcv-prop"></a>


|  名稱  |  類型  |  必要  |  Description  | 
| --- | --- | --- | --- | 
|  名稱  |  類型  |  必要  |  描述  | 
| --- | --- | --- | --- | 
|  名稱  |  類型  |  必要  |  Description  | 
| --- | --- | --- | --- | 
|  dcv  |  物件  |  是  |  定義與 Amazon DCV 伺服器建立連線所需的屬性、設定日誌層級以及從何處載入 Amazon DCV Web 用戶端 SDK 資產和存取 DCV 資源的 URL 的物件。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-viewer.html)  | 
|  sessionId  |  String  |  是  |  Amazon DCV 工作階段 ID。 | 
|  authToken  |  String  |  是  |  連線至伺服器時要使用的身分驗證字符。 | 
|  serverUrl  |  String  |  是  |  執行中 Amazon DCV 伺服器的主機名稱和連接埠，格式如下：https：//https://dcv\_host\_address:port。例如：https：//https://my-dcv-server:8443。 | 
|  baseUrl  |  String  |  是  |  要從中載入 SDK 檔案的絕對或相對 URL。 | 
|  resourceBaseUrl  |  String  |  否 （預設："")  |  存取 DCV 資源的絕對或相對 URL。 | 
|  onDisconnect  |  函數  |  否 （預設：() => {})  |  中斷與 Amazon DCV 伺服器的連線時叫用回呼函數，且連線已關閉。 | 
|  logLevel  |  [LogLevel](dcv-module.md#LogLevel)  |  否 （預設：LogLevel.INFO)  |  要在檢視器中使用的日誌層級。 | 
|  observers  |  物件  |  否 （預設：{})  |  要包含 httpExtraHeadersCallback 和 httpExtraSearchParamsCallback 以定義其實作的物件。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-viewer.html)  | 
|  [httpExtraSearchParams](dcv-module.md#httpExtraSearchParamsCallback)  |  函數  |  否 （預設：() => {})  |  呼叫回呼函數，以在身分驗證和建立連線期間將自訂查詢參數插入 URLs。 | 
|  [httpExtraHeaders](dcv-module.md#httpExtraHeadersCallback)  |  函數  |  否 （預設：() => {})  |  在建立連線期間，要呼叫以將自訂標頭新增至 HTTP 請求的回呼函數。 | 

##### uiConfig
<a name="uiConfig-prop"></a>


|  名稱  |  類型  |  必要  |  Description  | 
| --- | --- | --- | --- | 
|  名稱  |  類型  |  必要  |  Description  | 
| --- | --- | --- | --- | 
|  名稱  |  類型  |  必要  |  描述  | 
| --- | --- | --- | --- | 
|  uiConfig  |  物件  |  否 （預設：{})  |  定義屬性的物件，以設定工具列是否可見，以及是否要在工具列上顯示全螢幕和多監視器按鈕。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-viewer.html)  | 
|  toolbar  |  物件  |  否 （預設：{})  |  物件定義工具列的組態選項。[See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/dcv/latest/websdkguide/dcv-viewer.html)  | 
|  visible  |  Boolean  |  否 （預設：true)  |  定義是否顯示或隱藏工具列的選項。 | 
|  fullscreenButton  |  Boolean  |  否 （預設：true)  |  定義是否顯示或隱藏工具列上全螢幕按鈕的選項。 | 
|  multimonitorButton  |  Boolean  |  否 （預設：true)  |  定義是否在工具列上顯示或隱藏多顯示器按鈕的選項。 |