DCV モジュール - Amazon DCV
方法メンバーデータ型とコールバックの定義

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

DCV モジュール

DCV プロトコルのクライアント側を実装するモジュール。

方法

authenticate(authParams) → {Authentication}

指定した Amazon DCV サーバーエンドポイントの認証プロセスを開始します。

パラメータ :

Name 型 説明
url string 実行中の Amazon DCV サーバーのホスト名とポートを次の形式で指定します: https://dcv_host_address:port 例: https://my-dcv-server:8443。
authenticationToken string 認証に使用する認証トークン。
callbacks authenticationCallbacks 認証プロセス中に呼び出すことができるコールバック。

戻り値:

- Authentication オブジェクト。

タイプ

Authentication

connect(config) → {Promise.<Connection>|Promise.<{code: ConnectionErrorCode, message: string}>}

指定した Amazon DCV サーバーエンドポイントに接続します。接続が成功した場合は Connection オブジェクトを返します。接続が失敗した場合はエラーオブジェクトを返します。

パラメータ :

Name 型 説明
config ConnectionConfig ConnectionConfig オブジェクト。

戻り値:

- Connection オブジェクト、またはエラーオブジェクト。

タイプ

Promise.<Connection> | Promise.<{code: ConnectionErrorCode, message: string}>

setLogHandler(handler) → {void}

カスタムログハンドラ関数を設定します。デフォルトのログハンドラをオーバーライドすると、ブラウザコンソールでデバッグするときに元のログエントリの位置が失われます。

パラメータ :

Name 型 説明
handler function カスタムログハンドラ関数。ハンドラ関数には、level (数値)、levelName (文字列)、domain (文字列)、message (文字列) が含まれます。

戻り値:

タイプ

void

setLogLevel(level) → {void}

ログレベルを設定します。これは、デフォルトのログハンドラが使用されている場合にのみ必要です。

パラメータ :

Name 型 説明
level LogLevel 使用するログレベル。

戻り値:

タイプ

void

メンバー

(constant) AudioError :AudioErrorCode

AudioError コードの列挙型。

タイプ:

(定数) AuthenticationError :AuthenticationErrorCode

AuthenticationError コードの列挙型。

タイプ:

(定数) ChannelError :ChannelErrorCode

ChannelError コードの列挙型。

タイプ:

(定数) ClosingReasonError :ClosingReasonErrorCode

ClosingReasonError コードの列挙型。

タイプ:

(定数) ConnectionError :ConnectionErrorCode

ConnectionError コードの列挙型。

タイプ:

(定数) CustomChannelError :CustomChannelErrorCode

CustomChannelError コードの列挙型。

タイプ:

(定数) DisplayConfigError :DisplayConfigErrorCode

DisplayConfigError コードの列挙型。

タイプ:

(定数) FileStorageError :FileStorageErrorCode

FileStorageError コードの列挙型。

タイプ:

(定数) LogLevel :LogLevel

使用可能な SDK ログレベル。

タイプ:

(定数) MultiMonitorError :MultiMonitorErrorCode

MultiMonitorError コードの列挙型。

タイプ:

(定数) ResolutionError :ResolutionErrorCode

ResolutionError コードの列挙型。

タイプ:

(定数) TimezoneRedirectionError :TimezoneRedirectionErrorCode

TimeZoneRerectionError コードの列挙型。

タイプ:

(定数) TimezoneRedirectionSetting :TimezoneRedirectionSettingCode

TimezoneRedirectionSetting コードの列挙型。

タイプ:

(定数) TimezoneRedirectionStatus :TimezoneRedirectionStatusCode

TimezoneRedirectionStatus の列挙型。

タイプ:

(定数) バージョン

Amazon DCV バージョンで、major、minor、patch、revision、extended、versionStr があります。

プロパティ:

Name 型 説明
major integer メジャーバージョン番号。
minor integer マイナーバージョン番号。
patch integer パッチバージョン番号。
revision integer リビジョン番号。
extended string 拡張文字列。
versionStr string メジャー番号、マイナー番号、パッチ番号、リビジョン番号を形式 major.minor.patch+build.revision で連結したもの。

(定数) ScreenshotError :ScreenshotErrorCode

ScreenShotError コードの列挙型。

タイプ:

(定数) WebcamError :WebcamErrorCode

WebcameError コードの列挙型。

タイプ:

データ型とコールバックの定義

AudioErrorCode

DCV モジュールで使用できる AudioError コードの列挙型。

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

タイプ:

  • 数値

authenticationCallbacks

認証コールバック

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
promptCredentials authPromptCredentialsCallback ユーザーが認証情報のチャレンジを受けたときに呼び出されるコールバック関数。
error authErrorCallback 認証が失敗したときに呼び出されるコールバック関数。
success authSuccessCallback 認証が成功したときに呼び出されるコールバック関数。
httpExtraSearchParamsCallback httpExtraSearchParamsCallback リクエストを開始する前にカスタムクエリパラメータを認証 URL に挿入するために authenticate メソッドで呼び出されるコールバック関数。また、connect メソッドで使用して、DCV サーバーへの WebSocket 接続を確立するときに使用する URL をカスタマイズすることもできます。

AuthenticationErrorCode

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

タイプ:

  • 数値

authErrorCallback(authentication, error)

認証が失敗したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
authentication Authentication Authentication オブジェクト。
error オブジェクト 認証プロセスによって発生したエラーオブジェクト。
Name 型 説明
code AuthenticationErrorCode エラーコードです。
message string エラーメッセージです。

authPromptCredentialsCallback(authentication, challenge)

ユーザーが認証情報のチャレンジを受けたときに呼び出されるコールバック関数。ユーザーは、要求された認証情報を提供してチャレンジに応答する必要があります。

パラメータ :

Name 型 説明
authentication Authentication Authentication オブジェクト。
challenge オブジェクト チャレンジ。
Name 型 説明
requiredCredentials Array.<Object> リクエストされた認証情報オブジェクトの配列。
Name 型 説明
name string リクエストされた認証情報の名前。
type string リクエストされた認証情報の型。

authSuccessCallback(authentication, authenticationData)

認証が成功したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
authentication Authentication Authentication オブジェクト。
authenticationData Array.<Object> Amazon DCV セッション ID と認証トークンを含むオブジェクトの配列。
Name 型 説明
sessionId string Amazon DCV セッション ID。
authToken string Amazon DCV セッションの認証トークン。

[チャネル]

指定できる使用可能なチャンネル。

タイプ:

  • "clipboard" | "display" | "input" | "audio" | "filestorage"

ChannelErrorCode

DCV モジュールで使用できる ChannelError コードの列挙型。

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

タイプ:

  • number

clipboardEventCallback(event)

clipboardEvent の生成時に呼び出されるコールバック関数。

パラメータ :

Name 型 説明
event オブジェクト クリップボードイベントに関する情報。
Name 型 属性 説明
name established | copy | dataSizeAlert | autoCopyDone | newDataAvailable 常に存在します。イベントの名前。
clipboardData Object | string クリップボード内のデータ。
autoCopy boolean <optional> セッションクリップボードからローカルクライアントクリップボードへの自動コピーが有効かどうかを示します。
maxDataSize 数値 <optional> クリップボードに配置できるデータの最大量。
error string <optional> エラー情報 (該当する場合)。

ClosingReasonErrorCode

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

タイプ:

  • 数値

Colorspace

指定できる使用可能な色空間。

タイプ:

  • "RGB" | "YUV_REC601" | "YUV_REC709"

connectionCallbacks

接続エラーが発生した場合に呼び出すことができるコールバック。

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
disconnect disconnectCallback 接続の終了時に呼び出されるコールバック関数。
displayLayout displayLayoutCallback ディスプレイレイアウトまたは解像度が変更されたときに呼び出されるコールバック関数。
displayAvailability displayAvailabilityCallback ディスプレイの可用性が変更されたときに呼び出されるコールバック関数。
firstFrame firstFrameCallback Amazon DCV サーバーから最初のフレームを受信したときに呼び出されるコールバック関数。
filePrinted filePrintedCallback ファイルが Amazon DCV サーバーに出力されるときに呼び出されるコールバック関数。
fileDownload fileDownloadCallback Amazon DCV サーバーからファイルをダウンロードする準備ができたときに呼び出されるコールバック関数。
dataChannel dataChannelCallback Amazon DCV サーバーからデータチャンネルの可用性に関する通知が送信されたときに呼び出されるコールバック関数。
licenseNotification licenseNotificationCallback Amazon DCV サーバーからライセンス状態に関する通知が送信されたときに呼び出されるコールバック関数。
idleWarningNotification idleWarningNotificationCallback Amazon DCV サーバーがアイドルタイムアウト警告を送信したときに呼び出されるコールバック関数。
collaboratorList collaboratorListCallback Amazon DCV サーバーがコラボレーターのリストを送信したときに呼び出されるコールバック関数 (Amazon DCV ウェブクライアント SDK バージョン 1.1.0 以降)。
qualityIndicatorState qualityIndicatorStateCallback 接続品質インジケータで状態が変化したときに呼び出されるコールバック関数。
filestorageEnabled filestorageEnabledCallback ファイルストレージが有効または無効になったときに呼び出されるコールバック関数。
featuresUpdate featuresUpdateCallback 機能のステータスが変化したときに呼び出されるコールバック関数。
clipboardEvent clipboardEventCallback clipboardEvent の生成時に呼び出されるコールバック関数。
deviceChangeEvent deviceChangeEventCallback deviceChange イベントがトリガーされたときに呼び出されるコールバック関数。
screenshot screenshotCallback screenshot が使用可能であるときに呼び出されるコールバック関数。
httpExtraSearchParamsCallback httpExtraSearchParamsCallback Amazon DCV サーバーへの WebSocket 接続を確立するときに URL をカスタマイズするために呼び出されるコールバック関数。このコールバックは、authenticate メソッドで使用して、SDK がリクエストを送信する前にクエリパラメータを認証 URL に動的に追加することもできます。
httpExtraHeadersCallback httpExtraHeadersCallback 接続の確立中に HTTP リクエストにカスタムヘッダーを追加するために呼び出されるコールバック関数。

ConnectionConfig

Amazon DCV 接続の設定。

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
url string 実行中の Amazon DCV サーバーのホスト名とポートを次の形式で指定します: https://dcv_host_address:port 例: https://my-dcv-server:8443。
sessionId string Amazon DCV セッション ID。
authToken string セッションへの接続に使用する認証トークン。
baseUrl string SDK ファイルのロード元である絶対 URL または相対 URL。
resourceBaseUrl string DCV リソースのアクセス元である絶対 URL または相対 URL。
enabledChannels Array.<Channel> 有効化できるチャンネルのリストを示します。指定しない場合、または空の配列を指定した場合、デフォルトによりすべての使用可能なチャンネルになります。
losslessColorspace Colorspace 使用される色空間を示します。指定されない場合、デフォルトの「RGB」になります。
divId string SDK によりリモートストリームでキャンバスが作成される HTML DOM の div オブジェクトの ID。
volumeLevel integer 希望するボリュームレベル。有効範囲は 0～100 です。
clipboardAutoSync boolean 互換性のあるウェブブラウザで、Amazon DCV セッションクリップボードからローカルクライアントクリップボードへの自動コピーが有効かどうかを示します。
dynamicAudioTuning boolean 接続が確立されたときに、Amazon DCV サーバーのオーディオ設定に基づいてオーディオの動的チューニングを行うかどうかを示します。
clientHiDpiScaling boolean クライアントの DPI に基づいてキャンバスのスケーリングを行うかどうかを示します。
highColorAccuracy boolean 高い色精度が使用可能な場合に使用するかどうかを示します。指定されない場合、デフォルトは false です。
enableWebCodecs ブール値 WebCodecs が使用可能な場合に使用するかどうかを示します。指定されない場合のデフォルト値は false です。
observers connectionCallbacks 接続に関連するイベントを呼び出すためのコールバック関数。
callbacks connectionCallbacks observers プロパティと同じですが、各コールバックに Connection オブジェクトが最初のパラメータとして含まれます。

ConnectionErrorCode

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

タイプ:

  • 数値

createDirectory(path)

パラメータ :

Name 型 説明
path string ディレクトリを作成するサーバーの絶対パス。ターゲットディレクトリの名前も含まれます。

CustomChannelErrorCode

DCV モジュールで使用できる CustomChannelError コードの列挙型。

  • TRANSPORT_ERROR

タイプ:

  • 数値

dataChannelCallback(info)

Amazon DCV サーバーからデータチャンネルの可用性に関する通知が送信されたときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
info オブジェクト データチャンネルに関する情報。
Name 型 説明
name string データチャンネルの名前。
token string データチャンネルの認証トークン。

deleteFile(path)

パラメータ :

Name 型 説明
path string 削除するファイルを識別するサーバーの絶対パス。

deviceChangeEventCallback

deviceChange イベントがトリガーされたときに呼び出されるコールバック関数。

disconnectCallback(reason)

接続の終了時に呼び出されるコールバック関数。

パラメータ :

Name 型 説明
reason オブジェクト 切断の理由。
Name 型 説明
code 数値 理由コード。
message string 理由メッセージ。

displayAvailabilityCallback(status, displayId)

ディスプレイの可用性が変更されたときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
status オブジェクト ディスプレイのステータス。
Name 型 説明
enabled ブール型 ディスプレイが有効かどうかを示します。
closed boolean ディスプレイが閉じているかどうかを示します。
displayId 数値 ディスプレイの識別子。

DisplayConfigErrorCode

DCV モジュールで使用できる DisplayConfigError コードの列挙型。

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

タイプ:

  • 数値

displayLayoutCallback(serverWidth, serverHeight, heads)

ディスプレイレイアウトまたは解像度が変更されたときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
serverWidth 数値 プライマリディスプレイの幅 (ピクセル)。
serverHeight 数値 プライマリディスプレイの高さ (ピクセル)。
heads Array.<Monitor> Amazon DCV サーバーでサポートされるディスプレイヘッド。

機能

機能値。

  • display - シングルディスプレイビデオストリームの可用性を示します。

  • display-multi - マルチディスプレイビデオストリームの可用性を示します。

  • high-color-accuracy - 高い色精度の可用性を示します (Amazon DCV ウェブクライアント SDK バージョン 1.1.0 以降)。

  • mouse - マウス機能の可用性を示します。

  • keyboard - キーボード機能の可用性を示します。

  • keyboard-sas - SAS シーケンス (Control + Alt + Delete) 機能の可用性を示します。

  • 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 ウェブクライアント SDK バージョン 1.3.0 以降)。

タイプ:

  • string

featuresUpdateCallback(featuresList)

機能のステータスが変化したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
featuresList Array.<feature> 変化した一連の機能。

fileDownloadCallback(fileResource)

Amazon DCV サーバーからファイルをダウンロードする準備ができたときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
fileResource オブジェクト ダウンロード可能になったファイルに関する情報。
Name 型 説明
id string ファイルの識別子。
url string ファイルのダウンロードに使用する URL。
domain string リソースドメイン。
token string ファイルのダウンロードに使用する認証トークン。このトークンは URL にも含まれます。

filePrintedCallback(printResource)

ファイルが Amazon DCV サーバーに出力されるときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
printResource オブジェクト 印刷されたファイルに関する情報。
Name 型 説明
id string 印刷されたファイルの識別子。
url string 印刷されたファイルのダウンロードに使用する URL。
domain string リソースドメイン。この場合は printer。
token string 印刷されたファイルのダウンロードに使用する認証トークン。このトークンは URL にも含まれます。

filestorage

ファイルシステムにおけるアクションの調査と実行を可能にするオブジェクト。

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
list list サーバー上の提供されたパスに存在するアイテム (ファイルとディレクトリ) の一覧表示を許可する関数。
createDirectory createDirectory サーバー上の指定されたパスでのディレクトリ作成を許可する関数。
retrieveFile retrieveFile サーバー上の指定されたパスでファイルのローカルダウンロードを許可する関数。
deleteFile deleteFile サーバー上の指定されたパスでのファイル削除を許可する関数。
renameFile renameFile 指定ソースパスから指定送信先パスへのファイル名変更を許可する関数。
renameDirectory renameDirectory 指定ソースパスから絶対送信先パスへのディレクトリ名変更を許可する関数。
storeFile storeFile サーバー上の指定されたパスへのローカルファイルのアップロードを許可する関数。

filestorageEnabledCallback(enabled)

ファイルストレージが有効になったときに呼び出されるコールバック関数。Internet Explorer 11 のレイジーチャンネルのみ。

パラメータ :

Name 型 説明
enabled ブール型 ファイルストレージが有効かどうかを示します。

FileStorageErrorCode

DCV モジュールで使用できる FileStorageError コードの列挙型

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

タイプ:

  • 数値

firstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId)

Amazon DCV サーバーから最初のフレームを受信したときに呼び出されるコールバック関数。ディスプレイごとに放出されます。

パラメータ :

Name 型 説明
resizeEnabled ブール型 クライアントディスプレイのレイアウトのサイズ変更がサーバーでサポートされているかどうかを示します。
relativeMouseModeEnabled boolean 相対マウスモードがサーバーでサポートされているかどうかを示します。
displayId 数値 ディスプレイの識別子。

idleWarningNotificationCallback(disconnectionDateTime)

Amazon DCV サーバーがアイドルタイムアウト警告を送信したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
disconnectionDateTime 日付 切断の日時。

collaboratorListCallback(collaborators)

Amazon DCV サーバーがコラボレーターのリストを送信したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
collaborators Array.<Object> コラボレーターに関する情報を含むオブジェクトのリスト。
Name 型 説明
username string コラボレーターのユーザー名。
owner boolean コラボレーターがセッションオーナーであるかどうかを示します。
connectionId 数値 サーバーによって接続に割り当てられた ID を示します。

licenseNotificationCallback(notification)

Amazon DCV サーバーからライセンス状態に関する通知が送信されたときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
notification オブジェクト 通知。
Name 型 説明
product string DCV 生成物。
status string ライセンスのステータス。
message string メッセージ｡
leftDays 数値 ライセンスの有効期限が切れるまでの日数。
isDemo boolean ライセンスがデモライセンスかどうかを示します。
numUnlicensed 数値 ライセンスを取得していない接続の数。
licensingMode string ライセンス取得モード。
documentationUrl string ドキュメントの URL。

list(path)

パラメータ :

Name 型 説明
path string コンテンツを一覧表示するサーバー上の絶対パス。

LogLevel

使用可能な SDK ログレベル。

タイプ:

  • TRACE | DEBUG | INFO | WARN | ERROR | SILENT

モニタリング

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
name string ディスプレイヘッドの名前。
rect オブジェクト ディスプレイヘッドに関する情報。
Name 型 説明
x 数値 ディスプレイヘッドの最初の x 座標。
y 数値 ディスプレイヘッドの最初の y 座標。
width 数値 ディスプレイヘッドの幅 (ピクセル)。
height 数値 ディスプレイヘッドの高さ (ピクセル)。
primary boolean ディスプレイヘッドがプライマリディスプレイヘッドかどうかを示します。これは、リモートオペレーティングシステムがある場合はそこから決定されます。
dpi 数値 ディスプレイヘッドの DPI。

MultiMonitorErrorCode

DCV モジュールで使用できる MultimonitorError コードの列挙型

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

タイプ:

  • 数値

qualityIndicatorStateCallback(state)

接続品質インジケータで状態が変化したときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
state Array.<Object> 接続品質に関する情報。
Name 型 説明
name string インジケータの名前。
status NORMAL | WARNING | CRITICAL ステータスの説明。
changed boolean ステータスが変化したかどうかを示します。

renameDirectory(src, dest)

パラメータ :

Name 型 説明
src string 名前を変更するディレクトリを識別するサーバー上の絶対ソースパス。
dest string ターゲットパスとディレクトリ名を指定するサーバー上の絶対送信先パス。

renameFile(src, dest)

パラメータ :

Name 型 説明
src string 名前を変更するファイルを識別するサーバー上の絶対ソースパス。
dest string ターゲットパスとファイル名を指定するサーバー上の絶対送信先パス。

ResolutionErrorCode

DCV モジュールで使用できる ResolutionError コードの列挙型

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

タイプ:

  • 数値

ファイルの取得 (パス)

パラメータ :

Name 型 説明
path string ローカルでダウンロードするファイルを識別するサーバー上の絶対パス。

screenshotCallback(screenshot)

screenshotが使用可能であるときに呼び出されるコールバック関数。

パラメータ :

Name 型 説明
screenshot byte[] PNG 形式のスクリーンショットバッファ。スクリーンショットの取得に失敗した場合は null。

ScreenshotErrorCode

DCV モジュールで使用できる ScreenShotError コードの列挙型。

  • NO_CHANNEL

  • GENERIC_ERROR

タイプ:

  • 数値

serverInfo

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
name string ソフトウェアの名前。
version オブジェクト ソフトウェアのバージョン番号。
Name 型 説明
major 数値 メジャーバージョン番号。
minor 数値 マイナーバージョン番号。
revision 数値 リビジョンバージョン番号。
os string OS。
arch string アーキテクチャ。
hostname string ホスト名。

stats

タイプ:

  • オブジェクト

プロパティ:

Name 型 説明
fps 数値 現在のフレーム/秒。
traffic 数値 現在のトラフィック (ビット/秒)。
peakTraffic 数値 接続確立以降のトラフィックのピーク (ビット/秒)。
latency 数値 現在のレイテンシー (ミリ秒)。
currentChannels 数値 接続確立後から開いているチャンネルの数。
openedChannels 数値 現在開いているチャンネルの数。
channelErrors 数値 エラーを報告したチャンネルの数。

storeFile(file, dir)

パラメータ :

Name 型 説明
file File サーバーにアップロードするファイルオブジェクト (詳細については https://developer.mozilla.org/en-US/docs/Web/API/File を参照)。
dir string ファイルをアップロードするサーバーの絶対パス。

TimezoneRedirectionErrorCode

DCV モジュールで使用できる TimezoneRedirectionError コードの列挙型

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

タイプ:

  • 数値

TimezoneRedirectionSettingCode

DCV モジュールで使用できる TimezoneRedirectionSetting コードの列挙型

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

タイプ:

  • 数値

TimezoneRedirectionStatusCode

DCV モジュールで使用できる TimezoneRedirectionStatusCode コードの列挙型

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

タイプ:

  • 数値

WebcamErrorCode

DCV モジュールで使用できる WebcameError コードの列挙型

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

タイプ:

  • 数値

httpExtraSearchParamsCallback (メソッド、URL、本文)

認証と接続の確立中にカスタムクエリパラメータを URL に挿入するために呼び出されるコールバック関数。これにより、カスタムクエリパラメータを追加し、 AWS 署名バージョン 4 (SigV4) 署名値を追加して、外部システムを介した接続を保護および認可する機能など、高度な統合シナリオが可能になります。

このコールバックは、Amazon DCV サーバーへの WebSocket 接続を確立するときに使用する URL をカスタマイズする際にも使用されます。

パラメータ :

Name 型 説明
method string リクエストに使用されている HTTP メソッド。
url string リクエストに使用される URL。
body string リクエストボディのコンテンツ。

戻り値:

URL に追加するカスタムクエリパラメータを含む URLSearchParams オブジェクト。

タイプ

URLSearchParams

httpExtraHeadersCallback (メソッド、URL、本文)

接続の確立中に HTTP リクエストにカスタムヘッダー (Authorization など) を挿入するために呼び出されるコールバック関数。

パラメータ :

Name 型 説明
method string リクエストに使用されている HTTP メソッド。
url string リクエストに使用される URL。
body string リクエストボディのコンテンツ。

戻り値:

HTTP リクエストに追加するカスタムヘッダーを表すキーと値のペアを含むオブジェクト。

タイプ

オブジェクト