本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DCV 模組
實作DCV通訊協定用戶端的模組。
方法
清單
authentication(url,回呼) → {Authentication }
啟動指定 Amazon DCV 伺服器端點的身分驗證程序。
參數:
名稱 | Type | 描述 |
---|---|---|
url
|
string | 執行中 Amazon DCV伺服器的主機名稱和連接埠,格式如下:https://dcv_host_address:port 。例如:https://my-dcv-server:8443 。 |
callbacks
|
authenticationCallbacks | 在身分驗證程序期間可呼叫的回呼。 |
傳回:
- 驗證物件。
- Type
connect(config) → {Promise.<連線 >|Promise.<{code: ConnectionErrorCode, message: string}>}
連接至指定的 Amazon DCV 伺服器端點。如果連線成功,它會傳回 Connection 物件。如果連線失敗,它會傳回錯誤物件。
參數:
名稱 | Type | 描述 |
---|---|---|
config
|
ConnectionConfig | ConnectionConfig 物件。 |
傳回:
- 連線物件或錯誤物件。
- Type
-
承諾。<連線 > | Promise。<{code: ConnectionErrorCode, message: string}>
setLogHandler(處理常式) → {void}
設定自訂日誌處理常式函數。覆寫預設日誌處理常式時,使用瀏覽器主控台進行偵錯時,原始日誌項目位置將會遺失。
參數:
名稱 | Type | 描述 |
---|---|---|
handler
|
函數 | 自訂日誌處理常式函數。處理常式函數包含層級 (數字)、levelName(字串)、網域 (字串) 和訊息 (字串)。 |
傳回:
- Type
-
void
setLogLevel(層級) → {void}
設定日誌層級。只有在使用預設日誌處理常式時才需要這樣做。
參數:
名稱 | Type | 描述 |
---|---|---|
level
|
LogLevel | 欲使用的日誌層級。 |
傳回:
- Type
-
void
成員
清單
- (常數) AudioError:AudioErrorCode
- (常數) AuthenticationError:AuthenticationErrorCode
- (常數) ChannelError:ChannelErrorCode
- (常數) ClosingReasonError:ClosingReasonErrorCode
- (常數) ConnectionError:ConnectionErrorCode
- (常數) CustomChannelError:CustomChannelErrorCode
- (常數) DisplayConfigError:DisplayConfigErrorCode
- (常數) FileStorageError:FileStorageErrorCode
- (常數) LogLevel:LogLevel
- (常數) MultiMonitorError:MultiMonitorErrorCode
- (常數) ResolutionError:ResolutionErrorCode
- (常數) TimezoneRedirectionError:TimezoneRedirectionErrorCode
- (常數) TimezoneRedirectionSetting:TimezoneRedirectionSettingCode
- (常數) TimezoneRedirectionStatus:TimezoneRedirectionStatusCode
- (常數) 版本
- (常數) ScreenshotError:ScreenshotErrorCode
- (常數) WebcamError:WebcamErrorCode
(常數) 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。
屬性:
名稱 | 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
- authenticationCallbacks
- AuthenticationErrorCode
- authErrorCallback(身分驗證、錯誤)
- authPromptCredentials回呼 (身分驗證、挑戰)
- authSuccessCallback(身分驗證,authenticationData)
- 頻道
- ChannelErrorCode
- clipboardEventCallback(事件)
- ClosingReasonErrorCode
- 色彩空間
- connectionCallbacks
- ConnectionConfig
- ConnectionErrorCode
- createDirectory(路徑)
- CustomChannelErrorCode
- dataChannelCallback(資訊)
- deleteFile(路徑)
- deviceChangeEvent回呼 ()
- disconnectCallback(原因)
- displayAvailabilityCallback(狀態,displayId)
- DisplayConfigErrorCode
- displayLayoutCallback(serverWidth、serverHeight、 頭)
- 功能
- featuresUpdateCallback(featuresList)
- fileDownloadCallback(fileResource)
- filePrintedCallback(printResource)
- 檔案儲存
- filestorageEnabledCallback(已啟用)
- FileStorageErrorCode
- firstFrameCallback(resizeEnabled、 relativeMouseMode已啟用、displayId)
- idleWarningNotification回呼 (disconnectionDateTime)
- collaboratorListCallback(協作者)
- licenseNotificationCallback(通知)
- list(路徑)
- LogLevel
- 監控
- MultiMonitorErrorCode
- qualityIndicatorState回呼 (狀態)
- renameDirectory(src、dest)
- renameFile(src、dest)
- ResolutionErrorCode
- retrieveFile(路徑)
- screenshotCallback(螢幕擷取畫面)
- ScreenshotErrorCode
- serverInfo
- 統計資料
- storeFile(檔案、目錄)
- TimezoneRedirectionErrorCode
- TimezoneRedirectionSettingCode
- TimezoneRedirectionStatusCode
- WebcamErrorCode
AudioErrorCode
DCV 模組中可用的 AudioError 程式碼列舉
-
SETTING_AUDIO_FAILED
-
CHANNEL_NOT_AVAILABLE
類型:
-
number
authenticationCallbacks
驗證回呼
類型:
-
物件
屬性:
名稱 | Type | 描述 |
---|---|---|
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(身分驗證、錯誤)
驗證失敗時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身分驗證 | 驗證物件。 | |||||||||
error
|
物件 | 身分驗證程序產生的錯誤物件。
|
authPromptCredentials回呼 (身分驗證、挑戰)
當使用者遭受憑證挑戰時要呼叫的回呼函數。使用者必須提供請求的憑證來回答挑戰。
參數:
名稱 | Type | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身分驗證 | 驗證物件。 | |||||||||||||||
challenge
|
物件 | 挑戰。
|
authSuccessCallback(身分驗證,authenticationData)
驗證成功時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身分驗證 | 驗證物件。 | |||||||||
authenticationData
|
陣列。<物件> | 包含 Amazon DCV工作階段IDs和身分驗證權杖的物件陣列。
|
頻道
可指定的可用頻道。
類型:
-
"clipboard" | "display" | "input" | "audio" | "filestorage"
ChannelErrorCode
DCV 模組中可用的 ChannelError 程式碼列舉
-
ALREADY_OPEN
-
INITIALIZATION_FAILED
-
REJECTED
類型:
-
number
clipboardEventCallback(事件)
產生 時要呼叫clipboardEvent
的回呼函數。
參數:
名稱 | Type | 描述 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
event
|
物件 | 剪貼簿事件的相關資訊。
|
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
|
idleWarningNotification回撥 | Amazon DCV 伺服器傳送閒置逾時警告時要呼叫的回呼函數。 |
collaboratorList
|
collaboratorListCallback | Amazon DCV 伺服器傳送協作方清單時要呼叫的回呼函數 (自 Amazon DCV Web Client 1.1.0 SDK版起)。 |
qualityIndicatorState
|
qualityIndicatorState回撥 | 當連線品質指標變更狀態時要呼叫的回呼函數。 |
filestorageEnabled
|
filestorageEnabledCallback | 啟用或停用檔案儲存時要呼叫的回呼函數。 |
featuresUpdate
|
featuresUpdateCallback | 當功能的狀態變更時要呼叫的回呼函數。 |
clipboardEvent
|
clipboardEventCallback | 產生 時要呼叫clipboardEvent 的回呼函數。 |
deviceChangeEvent
|
deviceChangeEvent回撥 | 觸發deviceChange 事件時要呼叫的回呼函數。 |
screenshot
|
screenshotCallback | 當 screenshot 可用時要呼叫的回呼函數。 |
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 | 要URL從中載入SDK檔案的絕對或相對。 |
resourceBaseUrl
|
string | 存取DCV資源URL的絕對或相對。 |
enabledChannels
|
陣列。<頻道 > | 指示可啟用的頻道清單。如果未指定或提供空白陣列,則預設為所有可用的頻道。 |
losslessColorspace
|
色彩空間 | 指示將使用的色彩空間。如果未指定,則預設為 "RGB"。 |
divId
|
string | 中div 物件的 ID,SDK應在HTMLDOM其中使用遠端串流建立畫布。 |
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 Server 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
|
物件 | 有關資料頻道的資訊。
|
deleteFile(路徑)
參數:
名稱 | Type | 描述 |
---|---|---|
path
|
string | 伺服器上的絕對路徑,用於識別我們要刪除的檔案。 |
deviceChangeEvent回呼 ()
觸發deviceChange
事件時要呼叫的回呼函數。
disconnectCallback(原因)
連線結束時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
reason
|
物件 | 中斷連線的原因。
|
displayAvailabilityCallback(狀態,displayId)
當顯示器的可用性變更時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
status
|
物件 | 顯示的狀態。
|
|||||||||
displayId
|
number | 顯示的識別符。 |
DisplayConfigErrorCode
DCV 模組中可用的 DisplayConfigError 程式碼列舉
-
INVALID_ARGUMENT
-
UNSUPPORTED_OPERATION
-
NO_CHANNEL
類型:
-
number
displayLayoutCallback(serverWidth、serverHeight、 頭)
變更顯示配置或解析度時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 |
---|---|---|
serverWidth
|
數字 | 主要顯示器的寬度 (以像素為單位)。 |
serverHeight
|
number | 主要顯示器的高度 (以像素為單位)。 |
heads
|
陣列。<監視器 > | Amazon DCV 伺服器支援的顯示頭。 |
功能
功能值。
-
display
- 指示單一顯示器影片串流的可用性。 -
display-multi
- 指示多顯示器影片串流的可用性。 -
high-color-accuracy
- 表示高顏色準確性的可用性 (自 Amazon DCV Web Client 1.1.0 SDK版起)。 -
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 1.3.0 SDK版起)。
類型:
-
string
featuresUpdateCallback(featuresList)
當功能的狀態變更時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 |
---|---|---|
featuresList
|
Array.<feature > | 已變更的功能陣列。 |
fileDownloadCallback(fileResource)
準備好從 Amazon DCV 伺服器下載檔案時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fileResource
|
物件 | 準備好下載的檔案相關資訊。
|
filePrintedCallback(printResource)
在 Amazon DCV 伺服器上列印檔案時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
printResource
|
物件 | 已列印檔案的相關資訊。
|
檔案儲存
允許在檔案系統上探索和執行動作的物件。
類型:
-
物件
屬性:
名稱 | Type | 描述 |
---|---|---|
list
|
清單 | 允許列出存在於伺服器上所提供路徑的項目 (檔案和目錄) 的函數。 |
createDirectory
|
createDirectory | 允許在伺服器上指定路徑建立目錄的函數。 |
retrieveFile
|
retrieveFile | 允許在伺服器上指定路徑本機下載檔案的函數。 |
deleteFile
|
deleteFile | 允許在伺服器上指定路徑刪除檔案的函數。 |
renameFile
|
renameFile | 允許將檔案從指定來源路徑重新命名為指定目的地路徑的函數。 |
renameDirectory
|
renameDirectory | 允許將目錄從指定的來源路徑重新命名為絕對目的地路徑的函數。 |
storeFile
|
storeFile | 允許將本機檔案上傳至伺服器上所提供路徑的函數。 |
filestorageEnabledCallback(已啟用)
啟用檔案儲存時要呼叫的回呼函數。僅限 Internet Explorer 11 上的延遲頻道。
參數:
名稱 | Type | 描述 |
---|---|---|
enabled
|
布林值 | 指示是否已啟用檔案儲存。 |
FileStorageErrorCode
DCV 模組中可用的 FileStorageError 程式碼列舉
-
CANCELLED
-
ABORTED
-
INVALID_ARGUMENT
-
NOT_IMPLEMENTED
-
ERROR
-
ALREADY_EXIST
-
NOT_FOUND
類型:
-
number
firstFrameCallback(resizeEnabled、 relativeMouseMode已啟用、displayId)
從 Amazon DCV 伺服器接收第一個影格時要呼叫的回呼函數。為每個顯示器發出。
參數:
名稱 | Type | 描述 |
---|---|---|
resizeEnabled
|
布林值 | 指示伺服器是否支援調整用戶端顯示版面配置的大小。 |
relativeMouseModeEnabled
|
boolean | 指示伺服器是否支援相對滑鼠模式。 |
displayId
|
number | 顯示的識別符。 |
idleWarningNotification回呼 (disconnectionDateTime)
Amazon DCV 伺服器傳送閒置逾時警告時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 |
---|---|---|
disconnectionDateTime
|
日期 | 中斷連線的日期和時間。 |
collaboratorListCallback(協作者)
Amazon DCV 伺服器傳送協作方清單時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
collaborators
|
陣列。<物件> | 包含協作者資訊的物件清單。
|
licenseNotificationCallback(通知)
Amazon DCV 伺服器傳送授權狀態的通知時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
notification
|
物件 | 通知。
|
list(路徑)
參數:
名稱 | Type | 描述 |
---|---|---|
path
|
string | 要列出其內容之伺服器上的絕對路徑。 |
LogLevel
可用的SDK日誌層級。
類型:
-
TRACE | DEBUG | INFO | WARN | ERROR | SILENT
監控
類型:
-
物件
屬性:
名稱 | Type | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
string | 顯示頭的名稱。 | |||||||||||||||
rect
|
物件 | 顯示頭的相關資訊。
|
|||||||||||||||
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
qualityIndicatorState回呼 (狀態)
當連線品質指標變更狀態時要呼叫的回呼函數。
參數:
名稱 | Type | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
陣列。<物件> | 連線品質的相關資訊。
|
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
|
物件 | 軟體版本號碼。
|
||||||||||||
os
|
string | 作業系統。 | ||||||||||||
arch
|
string | 架構。 | ||||||||||||
hostname
|
string | 主機名稱。 |
統計資料
類型:
-
物件
屬性:
名稱 | Type | 描述 |
---|---|---|
fps
|
數字 | 目前的每秒影格數。 |
traffic
|
number | 以位元/秒為單位的目前流量。 |
peakTraffic
|
number | 自建立連線以來,以位元/秒為單位的流量峰值。 |
latency
|
number | 目前的延遲,以毫秒為單位。 |
currentChannels
|
number | 建立連線以來已開啟的頻道數量。 |
openedChannels
|
number | 目前開啟的頻道數目。 |
channelErrors
|
number | 已報告錯誤的頻道數量。 |
storeFile(檔案、目錄)
參數:
名稱 | Type | 描述 |
---|---|---|
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