本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
連線類別
呼叫 dcv
模組的 connect方法所取得的連線類別。如需示範如何使用的範例,請參閱入門一節。
公開
方法
清單
getConnectedDevices() → {Promise.<陣列。<MediaDeviceInfo>>|Promise.<{message: string}>}
getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>}
getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}
requestDisplayLayout(配置) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
requestResolution(寬度,高度) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
setMicrophone(啟用) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
setMicrophone(啟用, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
setWebcam(啟用, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}
attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>}
將特定顯示附加至視窗。您無法連接主要顯示器。如果成功,函數會傳回 displayId
。
參數:
名稱 | Type | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
win
|
物件 | 必須連接顯示所在的視窗。 | ||||||||||||
displayConf
|
物件 | 顯示器的組態。
|
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise.<number> | Promise.<{code: MultiMonitorErrorCode, message: string}>
captureClipboardEvents(啟用, win, displayId) → {void}
開始或停止接聽複製貼上事件。如果是互動式剪貼簿 (一律是貼上),我們需要開始聆聽複製/貼上事件。只有在需要時才開始和停止接聽可能很有用,例如,顯示模態時。
參數:
名稱 | Type | Attributes | 描述 |
---|---|---|---|
enabled
|
boolean | 若要開始接聽事件,請指定 true 。若要停止接聽事件,請指定 false 。 |
|
win
|
物件 | <選用> | 要接聽事件的視窗。如果省略,則會使用預設視窗。 |
displayId
|
number | <選用> | 應該監聽事件的顯示器 ID。如果省略,則會使用視窗的預設顯示。 |
傳回:
- Type
-
void
detachDisplay(displayId) → {void}
分離特定顯示。主要顯示器無法分離。
參數:
名稱 | Type | 描述 |
---|---|---|
displayId
|
number | 要分離的顯示器 ID。 |
傳回:
- Type
-
void
disconnect() → {void}
中斷與 Amazon DCV 伺服器的連線,並關閉連線。
傳回:
- Type
-
void
disconnectCollaborator(connectionId) → {void}
請求中斷與所提供連線 ID (自 Amazon DCV Web 用戶端 SDK 1.1.0 版起) 連線的協作器連線。
參數:
名稱 | Type | 描述 |
---|---|---|
connectionId
|
boolean | 將中斷連線的連線 ID。 |
傳回:
- Type
-
void
enableDisplayQualityUpdates(enable) → {void}
針對未接收更新的串流區域啟用或停用顯示品質更新。停用顯示品質更新可減少頻寬使用量,但也會降低顯示品質。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 若要啟用顯示品質更新,請指定 true 。若要停用顯示品質更新,請指定 false 。 |
傳回:
- Type
-
void
enableHighPixelDensity(啟用) → {void}
在用戶端上啟用或停用高像素密度。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 是否應該啟用高像素密度。 |
傳回:
- Type
-
void
enableTimezoneRedirection(enable) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>}
啟用或停用時區重新導向。啟用後,用戶端會請求伺服器使伺服器桌面時區與用戶端時區相符。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 若要啟用時區重新導向,請指定 true 。若要停用時區重新導向,請指定 false 。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise.<number> | Promise.<{code: TimezoneRedirectionErrorCode, message: string}>
enterRelativeMouseMode() → {void}
啟用相對滑鼠模式。
傳回:
- Type
-
void
getConnectedDevices() → {Promise.<陣列。<MediaDeviceInfo>>|Promise.<{message: string}>}
請求連接至用戶端電腦的媒體裝置清單。
傳回:
如果成功,它會傳回解析為 MediaDeviceInfo 物件陣列的 Promise。如需詳細資訊,請參閱 https://https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise。<陣列。<MediaDeviceInfo>> | Promise.<{message: string}>
getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>}
取得物件來管理 Amazon DCV 伺服器的檔案儲存。
傳回:
Promise。如果已完成,則解析為檔案總管物件,如果已拒絕,則解析為錯誤物件。
- Type
-
Promise.<filestorage> | Promise.<{code: ChannelErrorCode, message: string}>
getServerInfo() → {serverInfo}
取得 Amazon DCV 伺服器的相關資訊。
傳回:
伺服器軟體的相關資訊。
- Type
getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}
擷取 PNG 格式的遠端桌面螢幕擷取畫面。螢幕擷取畫面會在 screenshotCallback 觀察程式中傳回。 null
將在失敗時傳回。
傳回:
如果處理請求, 會解析的承諾。如果拒絕,我們會收到錯誤物件。
- Type
-
Promise | Promise。<{code: ScreenshotErrorCode, message: string}>
getStats() → {stats}
取得 Amazon DCV 伺服器的統計資料。
傳回:
串流統計資料的相關資訊。
- Type
latchModifierKey(金鑰、位置、isDown) → {布林值}
傳送允許修改器的單一鍵盤keydown
或keyup
事件。
參數:
名稱 | Type | 描述 |
---|---|---|
key
|
控制 | Alt | AltGraph | Meta | OS | Shift | 要傳送的金鑰。 |
location
|
KeyboardEvent.location | 金鑰的位置。如需詳細資訊,請參閱 https://https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location。 |
isDown
|
boolean | 如果要注入的金鑰事件是 keydown (true ) 或 keyup (false )。 |
傳回:
如果請求的組合有效,函數會傳回 true
,否則會傳回 false
。
- Type
-
boolean
openChannel(name, authToken, callbacks, namespace) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>}
如果在 Amazon DCV 伺服器上建立,請在連線上開啟自訂資料通道。
參數:
名稱 | Type | 描述 |
---|---|---|
name
|
string | 頻道名稱。 |
authToken
|
string | 用於連線至頻道的身分驗證字符。 |
callbacks
|
物件 | 要呼叫的 onMessage 和 onClose 回呼函數。 |
namespace
|
string | 頻道的命名空間。自 Amazon DCV Web 用戶端 SDK 1.2.0 和 Amazon DCV Server 2022.1 起提供。 |
傳回:
Promise。如果拒絕,我們會收到錯誤物件。
- Type
-
Promise | Promise。<{code: ChannelErrorCode, message: string}>
queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}
查詢特定 Amazon DCV 伺服器功能的狀態。
參數:
名稱 | Type | 描述 |
---|---|---|
featureName
|
功能 | 要查詢的功能名稱。 |
傳回:
Promise。如果已解決,函數會傳回物件,該status
物件一律包含 enabled
屬性,也可能包含其他屬性。如果拒絕,函數會傳回 error
物件。
- Type
-
{Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> | Promise.<{message: string}>
registerKeyboardShortcuts(快速鍵) → {void}
註冊鍵盤快速鍵。
參數:
名稱 | Type | 描述 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shortcuts
|
陣列。<物件> | 要註冊的金鑰和映射陣列。
|
傳回:
- Type
-
void
requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>}
從 Amazon DCV 伺服器請求更新的顯示組態。自 Amazon DCV Web 用戶端 SDK 1.1.0 和 Amazon DCV Server 2022.0 起提供。
參數:
名稱 | Type | 描述 |
---|---|---|
highColorAccuracy
|
boolean | 是否應請求高顏色準確度。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise | Promise。<{code: DisplayConfigErrorCode, message: string}>
requestDisplayLayout(配置) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
請求更新連線的顯示配置。
參數:
名稱 | Type | 描述 |
---|---|---|
layout
|
陣列。<Monitor> | 請求會顯示在配置中。 |
傳回:
Promise。如果拒絕,我們會收到錯誤物件。
- Type
-
Promise | Promise。<{code: ResolutionErrorCode, message: string}>
requestResolution(寬度,高度) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
從 Amazon DCV 伺服器請求更新的顯示器解析度。
參數:
名稱 | Type | 描述 |
---|---|---|
width
|
number | 請求的寬度,以像素為單位。允許的最低值為 0 。 |
height
|
number | 以像素為單位請求的高度。允許的最低值為 0 。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise | Promise。<{code: ResolutionErrorCode, message: string}>
sendKeyboardEvent(event) → {布林值}
傳送鍵盤快速鍵事件。如需鍵盤事件的詳細資訊,請參閱 https://https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEventkeypress
、 keydown
和 keyup
。如需這些事件的詳細資訊,請參閱 https://https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events
參數:
名稱 | Type | 描述 |
---|---|---|
event
|
KeyboardEvent | 要傳送的鍵盤事件。 |
傳回:
如果事件無效,函數會傳回 false
。如果事件有效,函數會傳回 true
。
- Type
-
boolean
sendKeyboardShortcut(shortcut) → {void}
傳送鍵盤快速鍵。使用此函數傳送完整 keydown
或 keyup
序列。例如,傳送 Ctrl + Alt + Del 會傳送keydown
事件之後所有金鑰keyup
的事件。即使您想要傳送單一金鑰,也請使用此函數。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
shortcut
|
陣列。<物件> | 要傳送的金鑰陣列。
|
傳回:
- Type
-
void
setDisplayQuality(min, maxopt) → {void}
設定用於連線的影像品質。有效範圍為 0
到 100
,影像品質1
最低,影像品質100
最高。指定 0
以保留目前的值。
參數:
名稱 | Type | Attributes | 描述 |
---|---|---|---|
min
|
number | 最低影像品質。 | |
max
|
number | <選用> | 最高影像品質。 |
傳回:
- Type
-
void
setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED)
自 1.3.0 版以來已棄用。不再需要設定顯示縮放。滑鼠座標將在內部自動管理。
通知 Amazon DCV 在用戶端擴展顯示。使用此選項來通知伺服器,其需要擴展滑鼠事件以符合用戶端的顯示比例。
參數:
名稱 | Type | 描述 |
---|---|---|
scaleRatio
|
float | 要使用的擴展比例。必須是嚴格正數。 |
displayId
|
number | 要擴展的顯示器 ID。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise | Promise。<{code: ResolutionErrorCode, message: string}>
setKeyboardQuirks(quirks) → {void}
設定用戶端電腦的鍵盤查詢。
參數:
名稱 | Type | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
quirks
|
物件 | 要啟用或停用的鍵盤查詢。
|
傳回:
- Type
-
void
setMaxDisplayResolution(maxWidth, maxHeight) → {void}
設定用於連線的最大顯示解析度。
參數:
名稱 | Type | 描述 |
---|---|---|
maxWidth
|
number | 以像素為單位的最大顯示寬度。允許的最低值為 0 。 |
maxHeight
|
number | 以像素為單位的最大顯示高度。允許的最低值為 0 。 |
傳回:
- Type
-
void
setMicrophone(啟用) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
啟用或停用麥克風。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 若要啟用麥克風,請指定 true 。若要停用麥克風,請指定 false 。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise | Promise。<{code: AudioErrorCode, message: string}>
setMinDisplayResolution(minWidth, minHeight) → {void}
設定用於連線的最低顯示解析度。有些應用程式可能需要最低的顯示解析度。如果所需的最低解析度大於用戶端支援的最大解析度,則會使用調整大小策略。請仔細使用此函數。調整大小策略可能會導致較不精確的滑鼠和觸控輸入系統。
參數:
名稱 | Type | 描述 |
---|---|---|
minWidth
|
number | 以像素為單位的最小顯示寬度。允許的最低值為 0 。 |
minHeight
|
number | 以像素為單位的最小顯示高度。允許的最低值為 0 。 |
傳回:
- Type
-
void
setUploadBandwidth(值) → {number}
設定用於將檔案上傳至 Amazon DCV 伺服器的最大頻寬。
參數:
名稱 | Type | 描述 |
---|---|---|
value
|
number | 最大頻寬限制,以 kbps 為單位。有效範圍為 1024 kbps 到 102400 kbps。 |
傳回:
- 設定的頻寬限制。null
如果伺服器上已停用檔案儲存功能。
- Type
-
number
setVolume(volume) → {void}
設定用於音訊的磁碟區層級。有效範圍為 0 到 100,0 為最低磁碟區,100 為最高磁碟區。
參數:
名稱 | Type | 描述 |
---|---|---|
volume
|
number | 要使用的磁碟區層級。 |
傳回:
- Type
-
void
setMicrophone(啟用, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
【實驗性 - 未來可能會變更】 啟用或停用麥克風。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 若要啟用麥克風,請指定 true 。若要停用麥克風,請指定 false 。 |
deviceId
|
string | 麥克風的裝置 ID。如果未提供 deviceId,則會使用 default deviceId。 |
傳回:
Promise。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise | Promise。<{code: AudioErrorCode, message: string}>
setWebcam(啟用, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}
啟用或停用網路攝影機。
參數:
名稱 | Type | 描述 |
---|---|---|
enable
|
boolean | 若要啟用網路攝影機,請指定 true 。若要停用網路攝影機,請指定 false 。 |
deviceId
|
string | 網路攝影機的裝置 ID。 |
傳回:
承諾如果成功, 會解析為已連接/已移除的網路攝影機 deviceId。如果拒絕,承諾會傳回錯誤物件。
- Type
-
Promise.<string> | Promise.<{code: WebcamErrorCode, message: string}>
syncClipboards() → {布林值}
同步本機用戶端剪貼簿與遠端 Amazon DCV 伺服器剪貼簿。瀏覽器必須支援自動複製。
傳回:
如果剪貼簿已同步,則函數會傳回 true
。如果剪貼簿尚未同步,或瀏覽器不支援自動複製,則函數會傳回 false
。
- Type
-
boolean