裝置入口網站 API 參照

發行項
07/12/2023

Windows 裝置入口網站中的所有內容都是以 REST API 為基礎建置，您可以用來存取資料，並以程式設計方式控制您的裝置。

應用程式部署

/api/app/packagemanager/package (DELETE)

卸載應用程式。

參數

package：要卸載之封裝的檔案名。

/api/app/packagemanager/package (POST)

安裝應用程式。

參數

package：要安裝的套件檔案名。

Payload

多部分符合 HTTP 主體

/api/app/packagemanager/packages (GET)

擷取系統上已安裝的應用程式清單。包含詳細資料。

傳回資料

具有詳細資料的已安裝套件清單

/api/app/packagemanager/state (GET)

取得進行中應用程式安裝的狀態。

傾印集合

/api/debug/dump/usermode/crashcontrol (DELETE)

停用側載應用程式的損毀傾印集合。

參數

packageFullName：套件名稱

/api/debug/dump/usermode/crashcontrol (GET)

取得側載應用程式損毀傾印集合的設定。

參數

packageFullName：套件名稱

/api/debug/dump/usermode/crashcontrol (POST)

啟用和設定側載應用程式的傾印控制設定。

參數

packageFullName：套件名稱

/api/debug/dump/usermode/crashdump (DELETE)

刪除側載應用程式的損毀傾印。

參數

packageFullName：套件名稱
fileName：傾印檔案名

/api/debug/dump/usermode/crashdump (GET)

擷取側載應用程式的損毀傾印。

參數

packageFullName：套件名稱
fileName：傾印檔案名

傳回資料

傾印檔案。使用 WinDbg 或 Visual Studio 檢查。

/api/debug/dump/usermode/dumps (GET)

傳回側載應用程式的所有損毀傾印清單。

傳回資料

每個側載應用程式的損毀傾印清單

ETW

/api/etw/providers (GET)

列舉已註冊的提供者。

傳回資料

提供者清單、易記名稱和 GUID

/api/etw/session/realtime (GET/WebSocket)

建立即時 ETW 會話;透過 Websocket 管理。

傳回資料

來自已啟用提供者的 ETW 事件

全像攝影版 OS

/api/holographic/os/etw/customproviders (GET)

傳回未向系統註冊的 HoloLens 特定 ETW 提供者清單。

/api/holographic/os/services (GET)

傳回所有執行中服務的狀態。

/api/holographic/os/settings/ipd (GET)

取得以公釐為單位的預存 IPD (Interpupillary 距離) 。

/api/holographic/os/settings/ipd (POST)

設定 IPD。

參數

ipd：要以公釐為單位的新 IPD 值

/api/holographic/os/webmanagement/settings/HTTPs (GET)

取得裝置入口網站的 HTTPS 需求。

/api/holographic/os/webmanagement/settings/HTTPs (POST)

設定裝置入口網站的 HTTPS 需求。

參數

必要：是、否或預設值

全像攝影感知

/api/holographic/perception/client (GET/WebSocket)

接受 WebSocket 升級，並執行以 30 fps 傳送更新的感知用戶端。

參數

clientmode：「主動」會在無法被動建立時強制視覺追蹤模式

全像攝影熱

使用這些熱 API 時，請參考管理電源和熱力一文。

/api/holographic/熱/階段 (GET)

取得裝置的熱階段 (0 正常，1 個暖，2 個重要) 。

/api/holographic/熱/getMitigationLevels (GET/websocket)

開啟 websocket (或執行單一 HTTP GET 查詢) ，並傳回包含下列專案的物件清單：

IsSuppressed - 識別指定的周邊是否隱藏風險降低
層級 - 此周邊的最新熱防護等級
遮罩 - 此周邊的遮罩
熱核心 - 此周邊的最新熱分數

物件會依周邊名稱命名 (範例：電池)

/api/holographic/熱/setMitigationLevel (POST)

變更所指定周邊所報告的風險降低等級

參數

mask：針對感興趣的周邊設定單一位的位元遮罩 (如需詳細資訊，請參閱 PowerThermalPeripheralFlags)
層級：使用 (0-3) 的新層級

/api/holographic/熱/setThermalScore (POST)

變更指定周邊所報告的熱分數

參數

mask：針對感興趣的周邊設定單一位的位元遮罩 (，請參閱 PowerThermalPeripheralFlags 以取得詳細資料)
熱分數：使用 (100-0) 的新熱分數

地圖管理員

/api/holographic/mapmanager/mapFiles (GET)

取得可用的地圖檔案清單， (.mapx) 。

/api/holographic/mapmanager/anchorFiles (GET)

取得可用錨點檔案的清單， (.ancx) 。

/api/holographic/mapmanager/srdbFiles (GET)

取得可用空間重建資料庫檔案的清單， (.srdb) 。

/api/holographic/mapmanager/getanchors (GET)

取得目前使用者的保存錨點清單。

下載/上傳/刪除檔案

/api/holographic/mapmanager/download (GET)

下載地圖、錨點或空間重建資料庫檔案。檔案先前必須已上傳或匯出。

參數

FileName：要下載的檔案名。

範例：

$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)

/api/holographic/mapmanager/upload (POST)

上傳地圖、錨點或空間重建資料庫檔案。上傳檔案之後，系統稍後就可以匯入及使用檔案。

參數

file：要上傳的檔案名。

範例：

var form_data = new FormData();
form_data.append("file", file_data);

$.ajax({
    url: "/api/holographic/mapmanager/upload",
    dataType: 'json',
    cache: false,
    contentType: false,
    processData: false,
    data: form_data,
    type: 'post'
})

/api/holographic/mapmanager/delete (POST)

刪除地圖、錨點或空間重建資料庫檔案。檔案先前必須已上傳或匯出。

參數

FileName：要刪除的檔案名。

範例：

$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)

匯出

/api/holographic/mapmanager/export (POST)

匯出系統目前使用的對應。匯出之後，即可下載它。

範例：

$.post("/api/holographic/mapmanager/export")

/api/holographic/mapmanager/exportanchors (POST)

匯出系統目前使用的對應。匯出之後，即可下載它。範例：

$.post("/api/holographic/mapmanager/exportanchors")

/api/holographic/mapmanager/exportmapandanchors (POST)

匯出系統目前使用的地圖和錨點。匯出之後，即可下載它們。範例：

$.post("/api/holographic/mapmanager/exportmapandanchors")

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

匯出系統目前使用的地圖和空間重建資料庫。匯出之後，即可下載它們。

範例：

$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")

匯入

/api/holographic/mapmanager/import (POST)

向系統指出應該使用哪一個對應。可以在已匯出或上傳的檔案上呼叫。

參數

FileName：要使用的對應名稱。

範例：

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importanchors (POST)

表示應該使用錨點的系統。可以在已匯出或上傳的檔案上呼叫。

參數

FileName：要使用的錨點名稱。

範例：

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importspatialmappingdb (POST)

向系統指出應該使用哪些空間重建資料庫。可以在已匯出或上傳的檔案上呼叫。

參數

FileName：要使用的空間對應資料庫名稱。

範例：

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

其他

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

將系統重設為地圖、錨點和空間重建資料庫。

範例：

$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")

/api/holographic/mapmanager/status (GET)

取得系統的狀態，包括上次匯入地圖、錨點和空間重建資料庫檔案。

混合實境擷取

/api/holographic/mrc/file (GET)

從裝置下載混合實境檔案。使用 op=stream 查詢參數進行串流處理。

參數

filename：要取得之視訊檔案的名稱、hex64 編碼
op：stream

/api/holographic/mrc/file (DELETE)

從裝置刪除混合實境錄製。

參數

filename：要刪除之檔案的名稱、十六進位64 編碼

/api/holographic/mrc/files (GET)

傳回儲存在裝置上的混合實境檔案清單。

/api/holographic/mrc/photo (POST)

拍攝混合實境相片，並在裝置上建立檔案。

參數

holo：擷取全像投影：true 或 false (預設為 false)
pv：擷取 PV 相機：true 或 false (預設為 false)
RenderFromCamera： (HoloLens 2只從相片/視訊相機的角度) 轉譯：true 或 false (預設為 true)

/api/holographic/mrc/settings (GET)

取得預設的混合實境擷取設定。

/api/holographic/mrc/settings (POST)

設定預設的混合實境擷取設定。其中一些設定會套用至系統的 MRC 相片和視訊擷取。

/api/holographic/mrc/status (GET)

取得 Windows Device Portal 內混合實境擷取的狀態。

回應

回應包含 JSON 屬性，指出 Windows Device Portal 是否錄製視訊。

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

取得指定檔案的縮圖影像。

參數

filename：要求縮圖的檔案名稱、十六進位64 編碼

/api/holographic/mrc/video/control/start (POST)

啟動混合實境錄製。

參數

holo：擷取全像投影：true 或 false (預設為 false)
pv：擷取 PV 相機：true 或 false (預設為 false)
麥克風：擷取麥克風：true 或 false (預設為 false)
回送：擷取應用程式音訊：true 或 false (預設為 false)
RenderFromCamera： (HoloLens 2只) 從相片/視訊相機的角度轉譯：true 或 false (預設為 true)
vstab： (HoloLens 2僅) 啟用視訊防震：true 或 false (預設為 true)
vstabbuffer： (HoloLens 2僅) 視訊防震緩衝區延遲：0 到 30 個畫面格， (預設為 15 個畫面)

/api/holographic/mrc/video/control/stop (POST)

停止目前的混合實境錄製。

Mixed Reality串流

警告

由於回送隔離，您無法從裝置上的應用程式內連線到混合實境串流。

HoloLens 透過分散 mp4 的區塊式下載，支援混合實境的即時預覽。

混合實境資料流程會共用相同的參數集，以控制擷取的專案：

holo：擷取全像投影：true 或 false
pv：擷取 PV 相機：true 或 false
麥克風：擷取麥克風：true 或 false
回送：擷取應用程式音訊：true 或 false

如果未指定這些專案，則會擷取全像投影、相片/視訊相機和應用程式音訊。

如果指定了任何參數，則未指定的參數會預設為 false

僅) 選擇性參數 (HoloLens 2

RenderFromCamera：從相片/視訊相機的觀點轉譯：true 或 false (預設為 true)
vstab：啟用視訊防震：true 或 false (預設為 false)
vstabbuffer：視訊防震緩衝區延遲：0 到 30 個畫面格， (預設為 15 個畫面格)

/api/holographic/stream/live.mp4 (GET)

1280x720p 30fps 5Mbit 資料流程。

/api/holographic/stream/live_high.mp4 (GET)

1280x720p 30fps 5Mbit 資料流程。

/api/holographic/stream/live_med.mp4 (GET)

854x480p 30fps 2.5Mbit 資料流程。

/api/holographic/stream/live_low.mp4 (GET)

428x240p 15fps 0.6Mbit 資料流程。

網路

/api/networking/ipconfig (GET)

取得目前的 IP 組態。

OS 資訊

/api/os/info (GET)

取得作業系統資訊。

/api/os/machinename (GET)

取得電腦名稱稱。

/api/os/machinename (POST)

設定電腦名稱稱。

參數

名稱：要設定為的新電腦名稱稱十六進位64 編碼

Perception Simulation Control

/api/holographic/simulation/control/mode (GET)

取得模擬模式。

/api/holographic/simulation/control/mode (POST)

設定模擬模式。

參數

模式：模擬模式：預設、模擬、遠端、舊版

/api/holographic/simulation/control/stream (DELETE)

刪除控制項資料流程。

/api/holographic/simulation/control/stream (GET/WebSocket)

開啟控制項資料流程的 WebSocket 連線。

/api/holographic/simulation/control/stream (POST)

需要建立控制資料流程 (優先順序，) 或將資料張貼到建立的資料流程 (streamId 所需的資料流程) 。張貼的資料必須是 'application/octet-stream' 類型。

/api/holographic/simulation/display/stream (GET/WebSocket)

要求模擬視訊資料流程，其中包含在「模擬」模式中呈現至系統顯示的內容。一開始會傳送簡單的格式描述元標頭，後面接著 H.264 編碼的紋理，前面各有一個標頭，指出眼球索引和紋理大小。

感知模擬播放

/api/holographic/simulation/playback/file (DELETE)

刪除錄製。

參數

錄製：要刪除的錄製名稱。

/api/holographic/simulation/playback/file (POST)

上傳錄製。

/api/holographic/simulation/playback/files (GET)

取得所有錄製內容。

/api/holographic/simulation/playback/session (GET)

取得錄製的目前播放狀態。

參數

錄製：錄製的名稱。

/api/holographic/simulation/playback/session/file (DELETE)

卸載錄製。

參數

錄製：要卸載的錄製名稱。

/api/holographic/simulation/playback/session/file (POST)

載入錄製。

參數

錄製：要載入的錄製名稱。

/api/holographic/simulation/playback/session/files (GET)

取得所有已載入的錄製。

/api/holographic/simulation/playback/session/pause (POST)

暫停錄製。

參數

錄製：錄製的名稱。

/api/holographic/simulation/playback/session/play (POST)

播放錄製。

參數

錄製：錄製的名稱。

/api/holographic/simulation/playback/session/stop (POST)

停止錄製。

參數

錄製：錄製的名稱。

/api/holographic/simulation/playback/session/types (GET)

取得載入錄製中的資料類型。

參數

錄製：錄製的名稱。

認知模擬錄製

/api/holographic/simulation/recording/start (POST)

開始錄製。一次只能使用單一錄製。其中一個必須設定：頭部、手部、spatialMapping 或環境。

參數

head：設定為 1 以記錄前端資料。
手：設定為 1 以記錄手部資料。
spatialMapping：設定為 1 以記錄空間對應。
環境：設定為 1 以記錄環境資料。
name：錄製的名稱。
singleSpatialMappingFrame：設定為 1，只記錄單一空間對應框架。

/api/holographic/simulation/recording/status (GET)

取得錄製狀態。

/api/holographic/simulation/recording/stop (GET)

停止目前的錄製。錄製會以檔案的形式傳回。

效能資料

/api/resourcemanager/processes (GET)

傳回具有詳細資料的執行中進程清單。

傳回資料

JSON，其中包含每個進程的進程清單和詳細資料

/api/resourcemanager/systemperf (GET)

傳回系統效能統計資料 (I/O 讀取/寫入、記憶體統計資料等。

傳回資料

具有系統資訊的 JSON：CPU、GPU、記憶體、網路、IO

電源

/api/power/battery (GET)

取得目前的電池狀態。

/api/power/state (GET)

檢查系統是否處於低電源狀態。

遠端控制

/api/control/restart (POST)

重新開機目標裝置。

/api/control/shutdown (POST)

關閉目標裝置。

工作管理員

/api/taskmanager/app (DELETE)

停止新式應用程式。

參數

套件：應用程式套件的完整名稱，十六進位64 編碼
forcestop：強制所有進程停止 (=是)

/api/taskmanager/app (POST)

啟動新式應用程式

參數

appid：要啟動之應用程式的 PRAID、十六進位64 編碼
套件：應用程式套件的完整名稱，十六進位64 編碼

WiFi 管理

/api/wifi/interface (GET)

列舉無線網路介面。

傳回資料

具有詳細資料 (GUID、描述等無線介面的清單)

/api/wifi/network (DELETE)

刪除與指定介面上網路相關聯的設定檔。

參數

介面：網路介面 guid
設定檔：設定檔名稱

/api/wifi/networks (GET)

列舉指定網路介面上的無線網路。

參數

介面：網路介面 guid

傳回資料

在網路介面上找到具有詳細資料的無線網路清單

/api/wifi/network (POST)

連線或中斷連線至指定介面上的網路。

參數

介面：網路介面 guid
ssid：ssid、hex64 編碼，以連線至
op：連線或中斷連線
createprofile：是或否
key：共用金鑰、十六進位64 編碼

Windows Performance Recorder

/api/wpr/customtrace (POST)

上傳 WPR 設定檔，並使用上傳的設定檔開始追蹤。

Payload

多部分符合 HTTP 主體

傳回資料

傳回 WPR 會話狀態。

/api/wpr/status (GET)

擷取 WPR 會話的狀態

傳回資料

WPR 會話狀態。

/api/wpr/trace (GET)

停止 WPR (效能) 追蹤會話。

傳回資料

傳回追蹤 ETL 檔案

/api/wpr/trace (POST)

啟動 WPR (效能) 追蹤會話。

參數

設定檔：設定檔名稱。可用的設定檔會儲存在 perfprofiles/profiles.json 中

傳回資料

開始時，傳回 WPR 會話狀態。

裝置入口網站 API 參照

應用程式部署

傾印集合

ETW

全像攝影版 OS

全像攝影感知

全像攝影熱

地圖管理員

下載/上傳/刪除檔案

匯出

匯入

其他

混合實境擷取

Mixed Reality串流

網路

OS 資訊

Perception Simulation Control

感知模擬播放

認知模擬錄製

效能資料

電源

遠端控制

工作管理員

WiFi 管理

Windows Performance Recorder

另請參閱

其他資源