Eszközportál API-referenciája
A Windows eszközportálon minden a REST API-kra épül, amelyekkel programozott módon hozzáférhet az adatokhoz, és vezérelheti az eszközt.
Az alkalmazás üzembe helyezése
/api/app/packagemanager/package (DELETE)
Eltávolít egy alkalmazást.
Paraméterek
- csomag: Az eltávolítandó csomag fájlneve.
/api/app/packagemanager/package (POST)
Alkalmazás telepítése.
Paraméterek
- csomag: A telepíteni kívánt csomag fájlneve.
Hasznos adatok
- többrészes http-törzsnek megfelelő
/api/app/packagemanager/packages (GET)
Lekéri a rendszeren telepített alkalmazások listáját. A részleteket tartalmazza.
Adatok visszaküldése
- A telepített csomagok listája részletekkel
/api/app/packagemanager/state (GET)
Lekéri a folyamatban lévő alkalmazástelepítés állapotát.
Memóriakép-gyűjtemény
/api/debug/dump/usermode/crashcontrol (DELETE)
Letiltja az összeomlási memóriaképek gyűjtését egy közvetlenül betöltött alkalmazás esetében.
Paraméterek
- packageFullName: csomag neve
/api/debug/dump/usermode/crashcontrol (GET)
Lekéri a közvetlenül betöltött alkalmazások összeomlási memóriakép-gyűjteményének beállításait.
Paraméterek
- packageFullName: csomag neve
/api/debug/dump/usermode/crashcontrol (POST)
Engedélyezi és beállítja a memóriakép-vezérlés beállításait egy közvetlenül betöltött alkalmazáshoz.
Paraméterek
- packageFullName: csomag neve
/api/debug/dump/usermode/crashdump (DELETE)
Egy közvetlenül betöltött alkalmazás összeomlási memóriaképét törli.
Paraméterek
- packageFullName: csomag neve
- fileName: memóriaképfájl neve
/api/debug/dump/usermode/crashdump (GET)
Lekéri egy közvetlenül betöltött alkalmazás összeomlási memóriaképét.
Paraméterek
- packageFullName: csomag neve
- fileName: memóriaképfájl neve
Adatok visszaküldése
- Memóriaképfájl. Vizsgálja meg a WinDbg vagy a Visual Studio használatával.
/api/debug/dump/usermode/dumps (GET)
A közvetlenül betöltött alkalmazások összes összeomlási memóriaképének listáját adja vissza.
Adatok visszaküldése
- Az összeomlási memóriaképek oldalanként betöltött alkalmazásonkénti listája
ETW
/api/etw/providers (GET)
A regisztrált szolgáltatók számbavétele.
Adatok visszaküldése
- Szolgáltatók listája, rövid név és GUID
/api/etw/session/realtime (GET/WebSocket)
Valós idejű ETW-munkamenetet hoz létre; websocketen keresztül felügyelve.
Adatok visszaküldése
- ETW-események az engedélyezett szolgáltatóktól
Holografikus operációs rendszer
/api/holographic/os/etw/customproviders (GET)
Azon HoloLens-specifikus ETW-szolgáltatók listáját adja vissza, amelyek nincsenek regisztrálva a rendszerben.
/api/holographic/os/services (GET)
Az összes futó szolgáltatás állapotát adja vissza.
/api/holographic/os/settings/ipd (GET)
Lekéri a tárolt IPD-t (interpupilláris távolság) milliméterben.
/api/holographic/os/settings/ipd (POST)
Beállítja az IPD-t.
Paraméterek
- ipd: Új IPD-érték, amely milliméterben állítható be
/api/holographic/os/webmanagement/settings/https (GET)
Lekéri az eszközportál HTTPS-követelményeit.
/api/holographic/os/webmanagement/settings/https (POST)
Beállítja az eszközportál HTTPS-követelményeit.
Paraméterek
- kötelező: igen, nem vagy alapértelmezett
Holografikus érzékelés
/api/holographic/perception/client (GET/WebSocket)
Elfogadja a WebSocket frissítéseit, és egy észlelési ügyfelet futtat, amely 30 fps sebességgel küld frissítéseket.
Paraméterek
- clientmode: Az "aktív" kényszeríti a vizuális nyomkövetési módot, ha nem lehet passzívan létrehozni
Holografikus termikus
Ezeknek a termikus API-knak a használatakor tekintse meg a felügyeleti teljesítményről és a termikus erőforrásokról szóló cikket.
/api/holographic/thermal/stage (GET)
A készülék termikus fázisának lekérése (0 normál, 1 meleg, 2 kritikus).
/api/holographic/thermal/getMitigationLevels (GET/websocket)
Nyisson meg egy websocketet (vagy hajtson végre egyetlen HTTP GET-lekérdezést), és adja vissza az alábbi objektumlistát:
- IsSuppressed – Annak azonosítása, hogy egy adott periférián el vannak-e rejtve a kockázatcsökkentések
- Szint – A periféria legújabb hőcsökkentési szintje
- Maszk – A periféria maszkolása
- ThermalScore – A periféria legújabb termikus pontszáma
Az objektumok periférianév alapján vannak elnevezve (például: Akkumulátor)
/api/holographic/thermal/setMitigationLevel (POST)
Adott periféria kockázatcsökkentési szintjének módosítása
Paraméterek
- maszk: bitmaszk egyetlen bitkészlettel a periféria számára (részletekért lásd: PowerThermalPeripheralFlags )
- szint: új használatú szint (0-3)
/api/holographic/thermal/setThermalScore (POST)
Az adott periféria esetében jelentett termikus pontszám módosítása
Paraméterek
- maszk: bitmaszk egyetlen bitkészlettel a periféria számára (részletekért lásd: PowerThermalPeripheralFlags )
- thermalScore: új termikus pontszám (100-0)
Térképkezelő
/api/holographic/mapmanager/mapFiles (GET)
Lekéri az elérhető térképfájlok (.mapx) listáját.
/api/holographic/mapmanager/anchorFiles (GET)
Lekéri az elérhető horgonyfájlok (.ancx) listáját.
/api/holographic/mapmanager/srdbFiles (GET)
Lekéri az elérhető térbeli rekonstrukciós adatbázisfájlok (.srdb) listáját.
/api/holographic/mapmanager/getanchors (GET)
Lekéri az aktuális felhasználó rögzített horgonyainak listáját.
Fájlok letöltése/feltöltése/törlése
/api/holographic/mapmanager/download (GET)
Letölt egy térkép-, horgony- vagy térbeli rekonstrukciós adatbázisfájlt. A fájlt korábban fel kell tölteni vagy exportálni kell.
Paraméterek
- FileName: A letölteni kívánt fájl neve.
Példa:
$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)
/api/holographic/mapmanager/upload (POST)
Térképet, horgonyt vagy térbeli rekonstrukciós adatbázisfájlt tölt fel. Miután feltöltött egy fájlt, később importálhatja és felhasználhatja a rendszer.
Paraméterek
- file: A feltöltendő fájl neve.
Példa:
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)
Egy térkép-, horgony- vagy térbeli rekonstrukciós adatbázisfájlt töröl. A fájlt korábban fel kell tölteni vagy exportálni kell.
Paraméterek
- FileName: A törölni kívánt fájl neve.
Példa:
$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)
Exportálás
/api/holographic/mapmanager/export (POST)
Exportálja a rendszer által jelenleg használt térképet. Az exportálás után letölthető.
Példa:
$.post("/api/holographic/mapmanager/export")
/api/holographic/mapmanager/exportanchors (POST)
Exportálja a rendszer által jelenleg használt térképet. Az exportálás után letölthető. Példa:
$.post("/api/holographic/mapmanager/exportanchors")
/api/holographic/mapmanager/exportmapandanchors (POST)
Exportálja a rendszer által jelenleg használt térképet és horgonyokat. Az exportálás után letölthetők. Példa:
$.post("/api/holographic/mapmanager/exportmapandanchors")
/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)
Exportálja a rendszer által jelenleg használt térkép- és térrekonstrukciós adatbázist. Az exportálás után letölthetők.
Példa:
$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")
Importálás
/api/holographic/mapmanager/import (POST)
Azt jelzi a rendszernek, hogy melyik térképet kell használni. Az exportált vagy feltöltött fájlokon hívható meg.
Paraméterek
- FileName: A használni kívánt térkép neve.
Példa:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
/api/holographic/mapmanager/importanchors (POST)
Azt jelzi a rendszernek, hogy mely horgonyokat kell használni. Az exportált vagy feltöltött fájlokon hívható meg.
Paraméterek
- FileName: A használni kívánt horgonyok neve.
Példa:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
/api/holographic/mapmanager/importpatialmappingdb (POST)
Azt jelzi a rendszernek, hogy melyik térbeli rekonstrukciós adatbázist kell használni. Az exportált vagy feltöltött fájlokon hívható meg.
Paraméterek
- FileName: A használni kívánt térbeli leképezési adatbázis neve.
Példa:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
Egyéb
/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)
Állítsa alaphelyzetbe a rendszer térképét, horgonyait és térbeli rekonstrukciós adatbázisát.
Példa:
$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")
/api/holographic/mapmanager/status (GET)
Lekéri a rendszer állapotát, beleértve azt is, hogy mely térképeket, horgonyokat és térbeli rekonstrukciós adatbázisfájlokat importálták utoljára.
Mixed Reality Capture
/api/holographic/mrc/file (GET)
Letölt egy vegyes valósági fájlt az eszközről. A streameléshez használja az op=stream lekérdezési paramétert.
Paraméterek
- filename: A lekérni kívánt videofájl neve, hex64 kódolású
- op: stream
/api/holographic/mrc/file (DELETE)
Törli a vegyes valóság felvételét az eszközről.
Paraméterek
- filename: A törölni kívánt fájl neve, hex64 kódolása
/api/holographic/mrc/files (GET)
Az eszközön tárolt vegyes valósági fájlok listáját adja vissza.
/api/holographic/mrc/photo (POST)
Egy vegyes valósági fényképet készít, és létrehoz egy fájlt az eszközön.
Paraméterek
- holo: hologramok rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- pv: PV kamera rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- RenderFromCamera: (csak HoloLens 2) renderelés a fénykép-/videokamera szempontjából: igaz vagy hamis (alapértelmezés szerint igaz)
/api/holographic/mrc/settings (GET)
Lekéri a vegyes valóság alapértelmezett rögzítési beállításait.
/api/holographic/mrc/settings (POST)
Beállítja a vegyes valóság alapértelmezett rögzítési beállításait. Ezen beállítások némelyike a rendszer MRC-fényképére és videófelvételére van alkalmazva.
/api/holographic/mrc/status (GET)
Lekéri a vegyes valóság rögzítésének állapotát a Windows eszközportálon.
Reagálás
A válasz tartalmaz egy JSON-tulajdonságot, amely azt jelzi, hogy a Windows eszközportál videót rögzít-e.
{"IsRecording": boolean}
/api/holographic/mrc/thumbnail (GET)
Lekéri a megadott fájl miniatűr képét.
Paraméterek
- filename: Annak a fájlnak a neve, hex64 kódolású, amelyhez a miniatűrt kérik
/api/holographic/mrc/video/control/start (POST)
Elindít egy vegyes valósági felvételt.
Paraméterek
- holo: hologramok rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- pv: PV kamera rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- mikrofon: mikrofon rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- visszacsatolás: alkalmazás hangának rögzítése: igaz vagy hamis (alapértelmezés szerint hamis)
- RenderFromCamera: (csak HoloLens 2) renderelés a fénykép-/videokamera szempontjából: igaz vagy hamis (alapértelmezés szerint igaz)
- vstab: (csak HoloLens 2) videostabilizálás engedélyezése: igaz vagy hamis (alapértelmezés szerint igaz)
- vstabbuffer: (csak HoloLens 2) videostabilizálási puffer késése: 0-30 képkocka (alapértelmezés szerint 15 képkocka)
/api/holographic/mrc/video/control/stop (POST)
Leállítja a vegyes valóság aktuális felvételét.
streamelés Mixed Reality
Figyelemfelhívás
A visszacsatolás elkülönítése miatt nem lehet csatlakozni a vegyes valóság streameléséhez egy alkalmazáson belülről az eszközön.
A HoloLens a vegyes valóság élő előnézetét támogatja egy töredezett mp4 darabolt letöltésével.
A vegyes valóság streamjei ugyanazokat a paramétereket osztják meg a rögzített adatok szabályozásához:
- holo: hologramok rögzítése: igaz vagy hamis
- pv: PV kamera rögzítése: true vagy false
- mikrofon: mikrofon rögzítése: igaz vagy hamis
- visszacsatolás: alkalmazás hangának rögzítése: igaz vagy hamis
Ha ezek közül egyik sincs megadva, akkor a rendszer hologramokat, fénykép-/videokamerát és alkalmazáshangot rögzít.
Ha vannak megadva ilyenek, a meg nem határozott paraméterek alapértelmezés szerint false (hamis) értékre változnak.
Választható paraméterek (csak HoloLens 2)
- RenderFromCamera: renderelés a fénykép-/videokamera szemszögéből: igaz vagy hamis (alapértelmezés szerint igaz)
- vstab: videostabilizálás engedélyezése: igaz vagy hamis (alapértelmezés szerint hamis)
- vstabbuffer: videostabilizálási puffer késése: 0–30 képkocka (alapértelmezés szerint 15 képkocka)
/api/holographic/stream/live.mp4 (GET)
1280x720p 30fps 5Mbites stream.
/api/holographic/stream/live_high.mp4 (GET)
1280x720p 30fps 5Mbites stream.
/api/holographic/stream/live_med.mp4 (GET)
Egy 854x480p 30fps 2,5 Mbites stream.
/api/holographic/stream/live_low.mp4 (GET)
Egy 428x240p 15fps 0,6Mbit-os stream.
Hálózatkezelés
/api/networking/ipconfig (GET)
Lekéri az aktuális IP-konfigurációt.
Operációs rendszer adatai
/api/os/info (GET)
Lekéri az operációs rendszer adatait.
/api/os/machinename (GET)
Lekéri a gép nevét.
/api/os/machinename (POST)
Beállítja a gép nevét.
Paraméterek
- name: Új gép neve, hex64 kódolású, és a következőre van állítva:
Percepciószimuláció vezérlése
/api/holographic/simulation/control/mode (GET)
Lekéri a szimulációs módot.
/api/holographic/simulation/control/mode (POST)
Beállítja a szimulációs módot.
Paraméterek
- mód: szimulációs mód: alapértelmezett, szimuláció, távoli, örökölt
/api/holographic/simulation/control/stream (DELETE)
Vezérlőstream törlése.
/api/holographic/simulation/control/stream (GET/WebSocket)
Nyisson meg egy WebSocket-kapcsolatot egy vezérlőstreamhez.
/api/holographic/simulation/control/stream (POST)
Hozzon létre egy vezérlőstreamet (prioritás megadása kötelező), vagy tegye közzé az adatokat egy létrehozott streamben (streamId megadása kötelező). A közzétett adatok várhatóan "application/octet-stream" típusúak lesznek.
/api/holographic/simulation/display/stream (GET/WebSocket)
Szimulációs videóstream kérése, amely tartalmazza a rendszer által megjelenített tartalmat szimulációs módban. Kezdetben egy egyszerű formátumleíró fejléc lesz elküldve, majd a H.264 kódolású textúrák, és mindegyik előtt egy fejléc jelenik meg, amely a szemindexet és a textúra méretét jelzi.
Percepciószimuláció lejátszása
/api/holographic/simulation/playback/file (DELETE)
Felvétel törlése.
Paraméterek
- felvétel: A törölni kívánt felvétel neve.
/api/holographic/simulation/playback/file (POST)
Töltsön fel egy felvételt.
/api/holographic/simulation/playback/files (GET)
Szerezze be az összes felvételt.
/api/holographic/simulation/playback/session (GET)
A felvétel aktuális lejátszási állapotának lekérése.
Paraméterek
- felvétel: A felvétel neve.
/api/holographic/simulation/playback/session/file (DELETE)
Távolítsa el a felvételt.
Paraméterek
- felvétel: A kiveendő felvétel neve.
/api/holographic/simulation/playback/session/file (POST)
Töltsön be egy felvételt.
Paraméterek
- felvétel: A betöltendő felvétel neve.
/api/holographic/simulation/playback/session/files (GET)
Szerezze be az összes betöltött felvételt.
/api/holographic/simulation/playback/session/pause (POST)
Felvétel szüneteltetése.
Paraméterek
- felvétel: A felvétel neve.
/api/holographic/simulation/playback/session/play (POST)
Felvétel lejátszása.
Paraméterek
- felvétel: A felvétel neve.
/api/holographic/simulation/playback/session/stop (POST)
Állítsa le a felvételt.
Paraméterek
- felvétel: A felvétel neve.
/api/holographic/simulation/playback/session/types (GET)
Lekérheti a betöltött felvétel adattípusait.
Paraméterek
- felvétel: A felvétel neve.
Percepciószimuláció rögzítése
/api/holographic/simulation/recording/start (POST)
Felvétel indítása. Egyszerre csak egyetlen felvétel lehet aktív. Az egyiket be kell állítani: fej, kéz, spatialMapping vagy környezet.
Paraméterek
- head: Állítsa 1 értékre a fejadatok rögzítéséhez.
- kezek: A kézi adatok rögzítéséhez állítsa az 1 értéket.
- spatialMapping: 1 értékre van állítva a térbeli leképezés rögzítéséhez.
- környezet: A környezeti adatok rögzítéséhez állítsa az 1 értéket.
- name: A felvétel neve.
- singleSpatialMappingFrame: 1 értékre állítva csak egyetlen térbeli leképezési keretet rögzíthet.
/api/holographic/simulation/recording/status (GET)
Rögzítési állapot lekérése.
/api/holographic/simulation/recording/stop (GET)
Állítsa le az aktuális felvételt. A rendszer fájlként adja vissza a felvételt.
Teljesítményadatok
/api/resourcemanager/processes (GET)
A futó folyamatok listáját adja vissza részletekkel.
Adatok visszaküldése
- JSON az egyes folyamatok folyamatainak és részleteinek listájával
/api/resourcemanager/systemperf (GET)
Rendszerszintű teljesítménystatisztikákat ad vissza (I/O olvasási/írási, memóriastatisztikák stb.
Adatok visszaküldése
- JSON rendszerinformációkkal: CPU, GPU, Memória, Hálózat, I/O
Energiaellátás
/api/power/battery (GET)
Lekéri az akkumulátor aktuális állapotát.
/api/power/state (GET)
Ellenőrzi, hogy a rendszer alacsony energiaállapotban van-e.
Távvezérlő
/api/control/restart (POST)
Újraindítja a céleszközt.
/api/control/shutdown (POST)
Leállítja a céleszközt.
Feladatkezelő
/api/taskmanager/app (DELETE)
Leállítja a modern alkalmazásokat.
Paraméterek
- package: Az alkalmazáscsomag teljes neve, hex64 kódolással
- forcestop: Az összes folyamat leállításának kényszerítése (=igen)
/api/taskmanager/app (POST)
Modern alkalmazás indítása
Paraméterek
- appid: elindítandó alkalmazás PRAID azonosítója, hex64 kódolású
- package: Az alkalmazáscsomag teljes neve, hex64 kódolással
WiFi-kezelés
/api/wifi/interfaces (GET)
A vezeték nélküli hálózati adapterek számbavétele.
Adatok visszaküldése
- A vezeték nélküli adapterek listája részletekkel (GUID, leírás stb.)
/api/wifi/network (DELETE)
Törli a hálózathoz társított profilt egy megadott adapteren.
Paraméterek
- interface: hálózati adapter GUID azonosítója
- profil: profil neve
/api/wifi/networks (GET)
Számba adja a vezeték nélküli hálózatokat a megadott hálózati adapteren.
Paraméterek
- interface: hálózati adapter GUID azonosítója
Adatok visszaküldése
- A hálózati adapteren található vezeték nélküli hálózatok listája részletekkel
/api/wifi/network (POST)
A megadott adapteren lévő hálózathoz csatlakozik vagy megszakad.
Paraméterek
- interface: hálózati adapter GUID azonosítója
- ssid: ssid, hex64 kódolású, csatlakozáshoz
- op: csatlakozás vagy kapcsolat bontása
- createprofile: igen vagy nem
- kulcs: megosztott kulcs, hex64 kódolású
Windows Teljesítményrögzítő
/api/wpr/customtrace (POST)
Feltölt egy WPR-profilt, és megkezdi a nyomkövetést a feltöltött profil használatával.
Hasznos adatok
- többrészes http-törzsnek megfelelő
Adatok visszaküldése
- A WPR-munkamenet állapotát adja vissza.
/api/wpr/status (GET)
Lekéri a WPR-munkamenet állapotát
Adatok visszaküldése
- WPR-munkamenet állapota.
/api/wpr/trace (GET)
Leállítja a WPR (teljesítmény) nyomkövetési munkamenetét.
Adatok visszaküldése
- Visszaadja a nyomkövetési ETL-fájlt
/api/wpr/trace (POST)
Elindít egy WPR (teljesítmény) nyomkövetési munkamenetet.
Paraméterek
- profile: Profil neve. Az elérhető profilok tárolása a perfprofiles/profiles.json fájlban történik
Adatok visszaküldése
- Az indításkor a WPR-munkamenet állapotát adja vissza.