View a markdown version of this page

Amazon DCV ウェブ UI SDK - Amazon DCV

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon DCV ウェブ UI SDK

JavaScript React コンポーネントライブラリ。現在は、Amazon DCV サーバーに接続し、ツールバーをレンダリングしてリモートストリームと通信する DCVViewer という 1 つの React コンポーネントをエクスポートしています。

エクスポーズ

コンポーネント

リスト

DCVViewer

リモートストリームとの通信に役立つ機能を備えたツールバーをレンダリングする React コンポーネント。

プロパティ:

リスト
dcv
名前 型 必須 説明
dcv オブジェクト はい Amazon DCV サーバーへの接続を確立するために必要なプロパティを定義し、ログレベルと、Amazon DCV ウェブクライアント SDK アセットをロードして DCV リソースにアクセスする URL を設定するオブジェクト。
名前 型 必須 説明
sessionId 文字列 はい Amazon DCV セッション ID。
authToken String はい セッションへの接続に使用する認証トークン。
serverUrl String はい 実行中の Amazon DCV サーバーのホスト名とポートを次の形式で指定します: https://dcv_host_address:port。例: https://my-dcv-server:8443
baseUrl String はい SDK ファイルのロード元である絶対 URL または相対 URL。
resourceBaseUrl String No (default: "") DCV リソースのアクセス元である絶対 URL または相対 URL。
onDisconnect 関数 No (default: () => {}) コールバック関数は、Amazon DCV サーバーとの接続を切断したときに呼び出され、接続が閉じられます。
logLevel LogLevel No (default: LogLevel.INFO) ビューアで使用するログレベル。
observers オブジェクト いいえ (デフォルト: {}) 実装を定義するために httpExtraHeadersCallback と httpExtraSearchParamsCallback を含めるオブジェクト。
名前 型 必須 説明
httpExtraSearchParams 関数 No (default: () => {}) 認証と接続の確立中にカスタムクエリパラメータを URL に挿入するために呼び出されるコールバック関数。
httpExtraHeaders 関数 No (default: () => {}) 接続の確立中に HTTP リクエストにカスタムヘッダーを追加するために呼び出されるコールバック関数。
UIConfig
名前 型 必須 説明
uiConfig オブジェクト No (default: {}) ツールバーを表示するかどうか、および全画面表示ボタンとマルチモニターボタンをツールバーに表示するかどうかを設定するプロパティを定義するオブジェクト。
名前 型 必須 説明
toolbar オブジェクト No (default: {}) ツールバーの設定オプションを定義するオブジェクト。
名前 型 必須 説明
visible ブール値 No (default: true) ツールバーの表示/非表示を定義するオプション。
fullscreenButton ブール値 No (default: true) ツールバーの全画面表示ボタンの表示/非表示を定義するオプション。
multimonitorButton ブール値 No (default: true) ツールバーのマルチモニターボタンの表示/非表示を定義するオプション。