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

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

DCV モジュール

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

方法

authenticate(url, callbacks) → {Authentication}

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

[パラメータ:]

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

戻り値:

- Authentication オブジェクト。

タイプ

Authentication

connect(config) → {Promise.<接続 >|約束。<{code: ConnectionErrorCode、メッセージ: string}>}

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

[パラメータ:]

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

戻り値:

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

タイプ

約束。＜接続 > | Promise.<{code: ConnectionErrorCode、メッセージ: string}>

setLogHandler（ハンドラー) → {void}

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

[パラメータ:]

名前 型 説明
handler function カスタムログハンドラ関数。ハンドラー関数には、レベル (数値）、 levelName (文字列）、ドメイン (文字列）、およびメッセージ (文字列) が含まれます。

戻り値:

タイプ

void

setLogLevel（レベル) → {void}

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

[パラメータ:]

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

戻り値:

タイプ

void

メンバー

（定数） 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

TimezoneRedirectionError コード列挙型。

タイプ:

（定数） TimezoneRedirectionSetting :TimezoneRedirectionSettingCode

TimezoneRedirectionSetting コード列挙型。

タイプ:

（定数） TimezoneRedirectionStatus :TimezoneRedirectionStatusCode

TimezoneRedirectionStatus コード列挙型。

タイプ:

(定数) バージョン

メジャー、マイナー、パッチ、リビジョン、拡張、 を含む Amazon DCVバージョンversionStr。

プロパティ:

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

（定数） ScreenshotError :ScreenshotErrorCode

ScreenshotError コード列挙型。

タイプ:

（定数） WebcamError :WebcamErrorCode

WebcamError コード列挙型。

タイプ:

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

リスト

AudioErrorCode

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

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

タイプ:

  • number

authenticationCallbacks

認証コールバック

タイプ:

  • オブジェクト

プロパティ:

名前 型 説明
promptCredentials authPromptCredentialsコールバック ユーザーが認証情報のチャレンジを受けたときに呼び出されるコールバック関数。
error authErrorCallback 認証が失敗したときに呼び出されるコールバック関数。
success authSuccessCallback 認証が成功したときに呼び出されるコールバック関数。

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

タイプ:

  • number

authErrorCallback（認証、エラー）

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

[パラメータ:]

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

authPromptCredentialsコールバック (認証、チャレンジ）

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

[パラメータ:]

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

authSuccessCallback（認証、authenticationData）

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

[パラメータ:]

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

Channel

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

タイプ:

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

ChannelErrorCode

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

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

タイプ:

  • number

clipboardEventCallback（イベント）

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

[パラメータ:]

名前 型 説明
event オブジェクト クリップボードイベントに関する情報。
名前 型 属性 説明
name 確立された | コピー | 貼り付け | dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData 常に存在します。イベントの名前。
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

タイプ:

  • number

Colorspace

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

タイプ:

  • RGB「」 |YUV「_REC601」 |YUV「_REC709」

connectionCallbacks

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

タイプ:

  • オブジェクト

プロパティ:

名前 型 説明
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 idleWarningNotificationコールバック Amazon DCVサーバーがアイドルタイムアウト警告を送信するときに呼び出されるコールバック関数。
collaboratorList collaboratorListCallback Amazon DCVサーバーがコラボレーターのリストを送信するときに呼び出されるコールバック関数 (Amazon DCV Web Client SDKバージョン 1.1.0 以降）。
qualityIndicatorState qualityIndicatorStateコールバック 接続品質インジケータで状態が変化したときに呼び出されるコールバック関数。
filestorageEnabled filestorageEnabledCallback ファイルストレージが有効または無効になったときに呼び出されるコールバック関数。
featuresUpdate featuresUpdateCallback 機能のステータスが変化したときに呼び出されるコールバック関数。
clipboardEvent clipboardEventCallback clipboardEvent の生成時に呼び出されるコールバック関数。
deviceChangeEvent deviceChangeEventコールバック deviceChange イベントがトリガーされたときに呼び出されるコールバック関数。
screenshot screenshotCallback screenshot が使用可能であるときに呼び出されるコールバック関数。

ConnectionConfig

Amazon DCV接続の設定。

タイプ:

  • オブジェクト

プロパティ:

名前 型 説明
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する絶対または相対。
resourceBaseUrl string DCV リソースURLにアクセスする絶対または相対。
enabledChannels Array.<Channel> 有効化できるチャンネルのリストを示します。指定しない場合、または空の配列を指定した場合、デフォルトによりすべての使用可能なチャンネルになります。
losslessColorspace Colorspace 使用される色空間を示します。指定しない場合、デフォルトはRGB「」になります。
divId string HTML DOM がリモートストリームでキャンバスSDKを作成する 内のdivオブジェクトの ID。
volumeLevel integer 希望するボリュームレベル。有効範囲は 0～100 です。
clipboardAutoSync ブール値 Amazon DCVセッションクリップボードからローカルクライアントクリップボードへの自動コピーが、互換性のあるウェブブラウザで有効になっているかどうかを示します。
dynamicAudioTuning ブール値 接続が確立されたときに、Amazon DCVサーバーのオーディオ設定に基づいてオーディオを動的に調整するかどうかを示します。
clientHiDpiScaling ブール値 クライアントの に基づいてキャンバスをスケーリングするかどうかを示しますDPI。
highColorAccuracy ブール値 高い色精度が使用可能な場合に使用するかどうかを示します。指定されない場合、デフォルトは 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サーバー 2021.0 以降）

  • INTERNAL_SERVER_ERROR (DCVサーバー 2021.0 以降）

  • AUTHENTICATION_FAILED (DCVサーバー 2021.0 以降）

  • PROTOCOL_ERROR (DCVサーバー 2021.0 以降）

  • INVALID_SESSION_ID (DCVサーバー 2021.0 以降）

  • INVALID_CONNECTION_ID (DCVサーバー 2021.0 以降）

  • CONNECTION_LIMIT_REACHED (DCVサーバー 2021.0 以降）

  • SERVER_UNREACHABLE (DCVサーバー 2022.1 以降）

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL (DCVサーバー 2022.2 以降）

  • TRANSPORT_ERROR

タイプ:

  • number

createDirectory（パス）

[パラメータ:]

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

CustomChannelErrorCode

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

  • TRANSPORT_ERROR

タイプ:

  • number

dataChannelCallback（情報）

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

[パラメータ:]

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

deleteFile（パス）

[パラメータ:]

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

deviceChangeEventコールバック ()

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

disconnectCallback（理由）

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

[パラメータ:]

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

displayAvailabilityCallback（ステータス、displayId）

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

[パラメータ:]

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

DisplayConfigErrorCode

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

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

タイプ:

  • number

displayLayoutCallback（serverWidth、serverHeight、ヘッド）

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

[パラメータ:]

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

機能

機能値。

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

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

  • high-color-accuracy - 高い色精度の可用性を示します (Amazon DCV Web Client SDKバージョン 1.1.0 以降）。

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

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

  • keyboard-sas - SASシーケンス (コントロール + Alt + 削除) 機能の可用性を示します。

  • 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 Client SDKバージョン 1.3.0 以降）。

タイプ:

  • string

featuresUpdateCallback(featuresList)

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

[パラメータ:]

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

fileDownloadCallback(fileResource)

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

[パラメータ:]

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

filePrintedCallback(printResource)

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

[パラメータ:]

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

filestorage

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

タイプ:

  • オブジェクト

プロパティ:

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

filestorageEnabledCallback（有効）

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

[パラメータ:]

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

FileStorageErrorCode

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

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

タイプ:

  • number

firstFrameCallback（resizeEnabled、 relativeMouseMode有効、displayId）

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

[パラメータ:]

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

idleWarningNotificationコールバック (disconnectionDateTime）

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

[パラメータ:]

名前 型 説明
disconnectionDateTime 日付 切断の日時。

collaboratorListCallback（コラボレーター）

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

[パラメータ:]

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

licenseNotificationCallback（通知）

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

[パラメータ:]

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

list(path)

[パラメータ:]

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

LogLevel

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

タイプ:

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

モニタリング

タイプ:

  • オブジェクト

プロパティ:

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

タイプ:

  • number

qualityIndicatorStateコールバック (状態）

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

[パラメータ:]

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

renameDirectory(src、dest)

[パラメータ:]

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

renameFile(src、dest)

[パラメータ:]

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

ResolutionErrorCode

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

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

タイプ:

  • number

retrieveFile（パス）

[パラメータ:]

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

screenshotCallback（スクリーンショット）

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

[パラメータ:]

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

ScreenshotErrorCode

DCV モジュールで使用できる ScreenshotError コード列挙

  • NO_CHANNEL

  • GENERIC_ERROR

タイプ:

  • number

serverInfo

タイプ:

  • オブジェクト

プロパティ:

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

stats

タイプ:

  • オブジェクト

プロパティ:

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

storeFile（ファイル、dir)

[パラメータ:]

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

TimezoneRedirectionErrorCode

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

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

タイプ:

  • number

TimezoneRedirectionSettingCode

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

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

タイプ:

  • number

TimezoneRedirectionStatusCode

DCV モジュールで使用できる TimezoneRedirectionStatus コード列挙

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

タイプ:

  • number

WebcamErrorCode

DCV モジュールで使用できる WebcamError コード列挙

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

タイプ:

  • number