DCV 模組 - Amazon DCV
方法成員輸入和回呼定義

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

DCV 模組

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

方法

authenticate(authParams) → {Authentication}

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

參數：

名稱 Type 描述
url string 執行中 Amazon DCV 伺服器的主機名稱和連接埠，格式如下：https://dcv_host_address:port。例如：https://my-dcv-server:8443。
authenticationToken string 用於身分驗證的身分驗證字符。
callbacks authenticationCallbacks 可在身分驗證程序期間呼叫的回呼。

傳回：

- 身分驗證物件。

Type

身分驗證

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

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

參數：

名稱 Type 描述
config ConnectionConfig ConnectionConfig 物件。

傳回：

- 連線物件或錯誤物件。

Type

Promise。＜Connection> | Promise.<{code： ConnectionErrorCode， message： string}>

setLogHandler(handler) → {void}

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

參數：

名稱 Type 描述
handler 函數 自訂日誌處理常式函數。處理常式函數包含關卡 (number)、levelName (string)、網域 (string) 和訊息 (string)。

傳回：

Type

void

setLogLevel(level) → {void}

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

參數：

名稱 Type 描述
level LogLevel 欲使用的日誌層級。

傳回：

Type

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 代碼列舉。

類型：

（常數） 版本

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

屬性：

名稱 Type 描述
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

身分驗證回呼

類型：

  • 物件

屬性：

名稱 Type 描述
promptCredentials authPromptCredentialsCallback 當使用者受到憑證挑戰時要呼叫的回呼函數。
error authErrorCallback 驗證失敗時要呼叫的回呼函數。
success authSuccessCallback 身分驗證成功時要呼叫的回呼函數。
httpExtraSearchParamsCallback httpExtraSearchParamsCallback authenticate 方法中要呼叫的回呼函數，用於在啟動請求之前將自訂查詢參數插入身分驗證 URL。它也可以用於 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

類型：

  • number

authErrorCallback（身分驗證、錯誤）

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

參數：

名稱 Type 描述
authentication 身分驗證 身分驗證物件。
error 物件 身分驗證程序引發的錯誤物件。
名稱 Type 描述
code AuthenticationErrorCode 錯誤代碼。
message string 錯誤訊息。

authPromptCredentialsCallback （身分驗證、挑戰）

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

參數：

名稱 Type 描述
authentication 身分驗證 身分驗證物件。
challenge 物件 挑戰。
名稱 Type 描述
requiredCredentials 陣列。＜物件＞ 請求的登入資料物件陣列。
名稱 Type 描述
name string 請求的登入資料名稱。
type string 請求的登入資料的類型。

authSuccessCallback（身分驗證、 authenticationData)

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

參數：

名稱 Type 描述
authentication 身分驗證 身分驗證物件。
authenticationData 陣列。＜物件＞ 包含 Amazon DCV 工作階段 IDs 和身分驗證字符的物件陣列。
名稱 Type 描述
sessionId string Amazon DCV 工作階段 ID。
authToken string Amazon DCV 工作階段的身分驗證字符。

頻道

可指定的可用頻道。

類型：

  • "剪貼簿" | "display" | "input" | "audio" | "filestorage"

ChannelErrorCode

DCV 模組中可用的 ChannelError 程式碼列舉

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

類型：

  • number

clipboardEventCallback（事件）

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

參數：

名稱 Type 描述
event 物件 剪貼簿事件的相關資訊。
名稱 Type Attributes 描述
name 已建立 | 複製 | 貼上 | dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData 永遠存在。事件的名稱。
clipboardData 物件 | 字串 剪貼簿中的資料。
autoCopy boolean ＜選用＞ 指出是否已啟用從工作階段剪貼簿自動複製到本機用戶端剪貼簿。
maxDataSize number ＜選用＞ 可放置在剪貼簿中的資料量上限。
error string ＜選用＞ 適用時的錯誤資訊。

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

色彩空間

可指定的可用色彩空間。

類型：

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

connectionCallbacks

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

類型：

  • 物件

屬性：

名稱 Type 描述
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 Web 用戶端 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 連線的組態。

類型：

  • 物件

屬性：

名稱 Type 描述
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 陣列。＜頻道＞ 指出可啟用的頻道清單。如果未指定或提供空白陣列，則預設為所有可用的頻道。
losslessColorspace 色彩空間 指出將使用的色彩空間。如果未指定，則預設為 "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 針對與連線相關的事件呼叫的回呼函數。
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 伺服器 2022.1 起）

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL （自 DCV Server 2022.2 起）

  • TRANSPORT_ERROR

類型：

  • number

createDirectory（路徑）

參數：

名稱 Type 描述
path string 伺服器上要建立目錄的絕對路徑。它還應該包含目標目錄的名稱。

CustomChannelErrorCode

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

  • TRANSPORT_ERROR

類型：

  • number

dataChannelCallback（資訊）

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

參數：

名稱 Type 描述
info 物件 有關資料頻道的資訊。
名稱 Type 描述
name string 資料通道的名稱。
token string 資料通道的身分驗證字符。

deleteFile（路徑）

參數：

名稱 Type 描述
path string 伺服器上識別我們要刪除之檔案的絕對路徑。

deviceChangeEventCallback()

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

disconnectCallback（原因）

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

參數：

名稱 Type 描述
reason 物件 中斷連線的原因。
名稱 Type 描述
code number 原因代碼。
message string 原因訊息。

displayAvailabilityCallback(status， displayId)

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

參數：

名稱 Type 描述
status 物件 顯示的狀態。
名稱 Type 描述
enabled boolean 指出是否已啟用顯示。
closed boolean 指出顯示是否關閉。
displayId number 顯示的識別符。

DisplayConfigErrorCode

DCV 模組中可用的 DisplayConfigError 程式碼列舉

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

類型：

  • number

displayLayoutCallback(serverWidth、serverHeight、heads)

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

參數：

名稱 Type 描述
serverWidth number 主要顯示器的寬度 （以像素為單位）。
serverHeight number 主要顯示器的高度 （以像素為單位）。
heads 陣列。＜Monitor＞ Amazon DCV 伺服器支援的顯示頭。

功能

功能值。

  • display - 指出單一顯示器視訊串流的可用性。

  • display-multi - 指出多顯示器視訊串流的可用性。

  • high-color-accuracy - 指出高色彩準確性的可用性 （自 Amazon DCV Web 用戶端 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 用戶端 SDK 1.3.0 版起）。

類型：

  • string

featuresUpdateCallback(featuresList)

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

參數：

名稱 Type 描述
featuresList Array.<feature＞ 已變更的功能陣列。

fileDownloadCallback(fileResource)

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

參數：

名稱 Type 描述
fileResource 物件 已準備好下載之檔案的相關資訊。
名稱 Type 描述
id string 檔案的識別符。
url string 用來下載檔案的 URL。
domain string 資源網域。
token string 用來下載檔案的身分驗證字符。權杖也包含在 URL 中。

filePrintedCallback(printResource)

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

參數：

名稱 Type 描述
printResource 物件 列印檔案的相關資訊。
名稱 Type 描述
id string 列印檔案的識別符。
url string 用來下載列印檔案的 URL。
domain string 資源網域。在此情況下，為 printer。
token string 用來下載列印檔案的身分驗證字符。權杖也包含在 URL 中。

檔案儲存

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

類型：

  • 物件

屬性：

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

filestorageEnabledCallback（已啟用）

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

參數：

名稱 Type 描述
enabled boolean 指出是否已啟用檔案儲存。

FileStorageErrorCode

DCV 模組中可用的 FileStorageError 程式碼列舉

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

類型：

  • number

firstFrameCallback(resizeEnabled， relativeMouseModeEnabled， displayId)

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

參數：

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

idleWarningNotificationCallback(disconnectionDateTime)

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

參數：

名稱 Type 描述
disconnectionDateTime 日期 中斷連線的日期和時間。

collaboratorListCallback（協作者）

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

參數：

名稱 Type 描述
collaborators 陣列。＜物件＞ 包含協作者相關資訊的物件清單。
名稱 Type 描述
username string 協作者的使用者名稱。
owner boolean 指出協作者是否為工作階段擁有者。
connectionId number 指出伺服器指派給連線的 ID。

licenseNotificationCallback（通知）

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

參數：

名稱 Type 描述
notification 物件 通知。
名稱 Type 描述
product string DCV 產品。
status string 授權的狀態。
message string 訊息。
leftDays number 授權到期之前的天數。
isDemo boolean 指出授權是否為示範授權。
numUnlicensed number 未授權連線的數量。
licensingMode string 授權模式。
documentationUrl string 文件的 URL。

list（路徑）

參數：

名稱 Type 描述
path string 伺服器上要列出內容的絕對路徑。

LogLevel

可用的 SDK 日誌層級。

類型：

  • 追蹤 | 除錯 | 資訊 | 警告 | 錯誤 | 靜音

監控

類型：

  • 物件

屬性：

名稱 Type 描述
name string 顯示頭的名稱。
rect 物件 顯示頭的相關資訊。
名稱 Type 描述
x number 顯示頭的初始x座標。
y number 顯示頭的初始y座標。
width number 顯示頭的寬度 （以像素為單位）。
height number 顯示頭的高度 （以像素為單位）。
primary boolean 指出顯示頭是否為主要顯示頭。如果可用，這取決於遠端作業系統。
dpi number 顯示頭的 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

qualityIndicatorStateCallback（狀態）

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

參數：

名稱 Type 描述
state 陣列。＜物件＞ 連線品質的相關資訊。
名稱 Type 描述
name string 指標的名稱。
status NORMAL | 警告 | 嚴重 狀態的描述。
changed boolean 指出狀態是否變更。

renameDirectory(src， dest)

參數：

名稱 Type 描述
src string 伺服器上識別要重新命名之目錄的絕對來源路徑。
dest string 伺服器上指定目標路徑和目錄名稱的絕對目的地路徑。

renameFile(src， dest)

參數：

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

ResolutionErrorCode

DCV 模組中可用的 ResolutionError 程式碼列舉

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

類型：

  • number

retrieveFile（路徑）

參數：

名稱 Type 描述
path string 伺服器上的絕對路徑，識別我們想要在本機下載的檔案。

screenshotCallback（螢幕擷取畫面）

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

參數：

名稱 Type 描述
screenshot byte[] PNG 格式的螢幕擷取畫面緩衝區，或螢幕擷取失敗null時。

ScreenshotErrorCode

DCV 模組中可用的 ScreenshotError 程式碼列舉

  • NO_CHANNEL

  • GENERIC_ERROR

類型：

  • number

serverInfo

類型：

  • 物件

屬性：

名稱 Type 描述
name string 軟體的名稱。
version 物件 軟體版本號碼。
名稱 Type 描述
major number 主要版本編號。
minor number 次要版本編號。
revision number 修訂版本編號。
os string 作業系統。
arch string 架構。
hostname string 主機名稱。

統計資料

類型：

  • 物件

屬性：

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

storeFile(file， dir)

參數：

名稱 Type 描述
file 檔案 要上傳至伺服器的檔案物件 （如需詳細資訊，請參閱 https：//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

httpExtraSearchParamsCallback（方法、url、內文）

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

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

參數：

名稱 Type 描述
method string 用於請求的 HTTP 方法。
url string 將用於請求的 URL。
body string 請求本體的內容。

傳回：

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

Type

URLSearchParams

httpExtraHeadersCallback（方法、url、內文）

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

參數：

名稱 Type 描述
method string 用於請求的 HTTP 方法。
url string 將用於請求的 URL。
body string 請求本體的內容。

傳回：

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

Type

物件