Referenční informace k rozhraní API portálu zařízení

Všechno na Portálu zařízení s Windows je postavené na rozhraní REST API, které můžete použít k přístupu k datům a k řízení zařízení prostřednictvím kódu programu.

Nasazení aplikací

/api/app/packagemanager/package (DELETE)

Odinstaluje aplikaci.

Parametry

• package(balíček): Název souboru balíčku, který se má odinstalovat.

/api/app/packagemanager/package (POST)

Nainstaluje aplikaci.

Parametry

• package:Název souboru balíčku, který se má nainstalovat.

Datová část

• text http s více částmi vyhovující

/api/app/packagemanager/packages (GET)

Načte seznam nainstalovaných aplikací v systému. Obsahuje podrobnosti.

Vrácení dat

• Seznam nainstalovaných balíčků s podrobnostmi

/api/app/packagemanager/state (GET)

Získá stav probíhající instalace aplikace.

Kolekce výpisů paměti

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

Zakáže shromažďování výpisů stavu systému pro aplikaci s zkušebním načtením.

Parametry

• packageFullName: název balíčku

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

Získá nastavení pro shromažďování výpisů stavu systému aplikací se zkušebním načtením.

Parametry

• packageFullName: název balíčku

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

Povolí a nastaví nastavení řízení výpisu paměti pro aplikaci načtenou bokem.

Parametry

• packageFullName: název balíčku

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

Odstraní výpis stavu systému pro aplikaci načtenou bokem.

Parametry

• packageFullName: název balíčku
• fileName: název souboru výpisu

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

Načte výpis stavu systému pro aplikaci načtenou bokem.

Parametry

• packageFullName: název balíčku
• fileName: název souboru výpisu

Vrácení dat

• Soubor s výpisem paměti. Kontrola pomocí WinDbg nebo sady Visual Studio

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

Vrátí seznam všech výpisů stavu systému pro aplikace načtené bokem.

Vrácení dat

• Seznam výpisů stavu systému pro aplikaci načtenou na straně

Trasování událostí pro Windows

/api/etw/providers (GET)

Vytvoří výčet registrovaných poskytovatelů.

Vrácení dat

• Seznam poskytovatelů, popisný název a IDENTIFIKÁTOR GUID

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

Vytvoří relaci trasování událostí v reálném čase; spravované přes websocket.

Vrácení dat

• Události trasování událostí pro windows od povolených zprostředkovatelů

Holografický operační systém

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

Vrátí seznam zprostředkovatelů etw specifických pro HoloLens, kteří nejsou zaregistrovaní v systému.

/api/holographic/os/services (GET)

Vrátí stavy všech spuštěných služeb.

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

Získá uloženou IPD (interpupilární vzdálenost) v milimetrech.

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

Nastaví IPD.

Parametry

• ipd: Nová hodnota IPD, která se má nastavit v milimetrech

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

Získá požadavky HTTPS pro portál zařízení.

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

Nastaví požadavky HTTPS pro portál zařízení.

Parametry

• povinné: ano, ne nebo výchozí

Holografické vnímání

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

Přijímá upgrady protokolu WebSocket a spouští klienta pro vnímání, který odesílá aktualizace rychlostí 30 snímků za sekundu.

Parametry

• clientmode: "aktivní" vynutí režim sledování vizuálů, když ho nejde navázat pasivně.

Holografické teploty

Při použití těchto rozhraní API pro teploty si projděte článek o správě výkonu a teplot .

/api/holographic/thermal/stage (GET)

Získejte tepelnou fázi zařízení (0 normální, 1 teplý, 2 kritické).

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

Otevřete websocket (nebo proveďte jeden dotaz HTTP GET) a vraťte seznam objektů obsahujících následující:

• IsSuppressed – identifikace, jestli u daného periferního zařízení došlo k potlačení zmírnění rizik.
• Level – nejnovější úroveň tepelného zmírnění pro toto periferní zařízení
• Maska – maska tohoto periferního zařízení
• ThermalScore – nejnovější tepelné skóre pro toto periferní zařízení

Objekty jsou pojmenované podle názvu periferního zařízení (příklad: Baterie).

/api/holographic/thermal/setMitigationLevel (POST)

Změna úrovně zmírnění rizik hlášené pro dané periferní zařízení

Parametry

• maska: bitová maska s jednou bitovou sadou pro periferní zařízení, které vás zajímá (podrobnosti najdete v tématu PowerThermalPeripheralFlags )
• level: nová úroveň k použití (0-3)

/api/holographic/thermal/setThermalScore (POST)

Změna tepelného skóre hlášeného pro dané periferní zařízení

Parametry

• maska: bitová maska s jedním bitem nastaveným pro periferní zařízení, které vás zajímá (podrobnosti viz PowerThermalPeripheralFlags )
• thermalScore: nové tepelné skóre pro použití (100-0)

Správce mapování

/api/holographic/mapmanager/mapFiles (GET)

Získá seznam dostupných souborů map (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Získá seznam dostupných souborů ukotvení (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Získá seznam dostupných souborů databáze prostorového obnovení (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Získá seznam trvalých ukotvení pro aktuálního uživatele.

Stažení, nahrání nebo odstranění souborů

/api/holographic/mapmanager/download (GET)

Stáhne soubor databáze mapy, ukotvení nebo prostorového obnovení. Soubor musí být dříve nahraný nebo exportovaný.

Parametry

• FileName: Název souboru ke stažení.

Příklad:

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

/api/holographic/mapmanager/upload (POST)

Nahraje soubor databáze mapy, ukotvení nebo prostorového obnovení. Po nahrání může být soubor později importován a používán systémem.

Parametry

• file: Název souboru, který se má nahrát.

Příklad:

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)

Odstraní mapování, ukotvení nebo soubor databáze prostorového obnovení. Soubor musí být dříve nahraný nebo exportovaný.

Parametry

• FileName: Název souboru, který chcete odstranit.

Příklad:

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

Export

/api/holographic/mapmanager/export (POST)

Exportuje mapu, kterou systém aktuálně používá. Po exportu se dá stáhnout.

Příklad:

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

/api/holographic/mapmanager/exportanchors (POST)

Exportuje mapu, kterou systém aktuálně používá. Po exportu se dá stáhnout. Příklad:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Exportuje mapu a kotvy aktuálně používané systémem. Po exportu se dají stáhnout. Příklad:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Exportuje mapovou databázi a databázi prostorové rekonstrukce, kterou systém aktuálně používá. Po exportu se dají stáhnout.

Příklad:

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

Import

/api/holographic/mapmanager/import (POST)

Označuje systému, která mapa se má použít. Lze volat u souborů, které byly exportovány nebo nahrány.

Parametry

• FileName: Název mapy, která se má použít.

Příklad:

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

/api/holographic/mapmanager/importanchors (POST)

Označuje systému, které kotvy se mají použít. Lze volat u souborů, které byly exportovány nebo nahrány.

Parametry

• FileName: Název ukotvení, které se mají použít.

Příklad:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Určuje systému, která databáze prostorové rekonstrukce by měla být použita. Lze volat u souborů, které byly exportovány nebo nahrány.

Parametry

• FileName: Název databáze prostorového mapování, která se má použít.

Příklad:

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

Jiné

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Resetujte systém databáze map, ukotvení a prostorového obnovení.

Příklad:

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

/api/holographic/mapmanager/status (GET)

Získá stav systému, včetně mapování, ukotvení a prostorového obnovení databázových souborů byly naposledy importovány.

Mixed Reality Capture

/api/holographic/mrc/file (GET)

Stáhne ze zařízení soubor hybridní reality. Pro streamování použijte parametr dotazu op=stream.

Parametry

• název_souboru: Název videosouboru s kódováním hex64, který se má získat
• op: stream

/api/holographic/mrc/file (DELETE)

Odstraní záznam hybridní reality ze zařízení.

Parametry

• filename: Název souboru, který se má odstranit, zakódovaný hex64

/api/holographic/mrc/files (GET)

Vrátí seznam souborů hybridní reality uložených v zařízení.

/api/holographic/mrc/photo (POST)

Pořídí fotku hybridní reality a vytvoří na zařízení soubor.

Parametry

• holo: capture hologramy: true nebo false (výchozí hodnota je false)
• pv: capture PV camera: true nebo false (výchozí hodnota je false)
• RenderFromCamera: (pouze HoloLens 2) vykreslení z perspektivy fotoaparátu nebo videokamery: true nebo false (výchozí hodnota je true)

/api/holographic/mrc/settings (GET)

Získá výchozí nastavení zachycení hybridní reality.

/api/holographic/mrc/settings (POST)

Nastaví výchozí nastavení zachycení hybridní reality. Některá z těchto nastavení se použijí pro pořizování fotek a videí v MRC systému.

/api/holographic/mrc/status (GET)

Získá stav zachycení hybridní reality na portálu zařízení s Windows.

Odpověď

Odpověď obsahuje vlastnost JSON, která indikuje, jestli portál zařízení s Windows nahrává video nebo ne.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Získá miniaturu pro zadaný soubor.

Parametry

• název_souboru: Název souboru, který je zakódován hex64, pro který se požaduje miniatura

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

Spustí záznam hybridní reality.

Parametry

• holo: capture hologramy: true nebo false (výchozí hodnota je false)
• pv: capture PV camera: true nebo false (výchozí hodnota je false)
• mic: zachycení mikrofonu: true nebo false (výchozí hodnota je false)
• loopback: capture app audio: true nebo false (výchozí hodnota false)
• RenderFromCamera: (pouze HoloLens 2) vykreslení z perspektivy fotoaparátu nebo videokamery: true nebo false (výchozí hodnota je true)
• vstab: (jenom HoloLens 2) povolte stabilizaci videa: true nebo false (výchozí hodnota je true).
• vstabbuffer: (pouze HoloLens 2) latence vyrovnávací paměti pro stabilizaci videa: 0 až 30 snímků (výchozí hodnota je 15 snímků)

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

Zastaví aktuální záznam hybridní reality.

streamování Mixed Reality

Upozornění

Kvůli izolaci zpětné smyčky se nemůžete připojit k hybridní realitě streamované z aplikace na zařízení.

HoloLens podporuje živý náhled hybridní reality prostřednictvím stažení fragmentovaného souboru MP4 v bloku.

Streamy hybridní reality sdílejí stejnou sadu parametrů, které určují, co se zaznamenává:

• holo: capture holograms: true nebo false
• pv: capture PV camera: true nebo false
• mic: capture microphone: true nebo false
• loopback: capture app audio: true nebo false

Pokud nezadáte žádnou z těchto možností, zachytí se hologramy, fotokamery a videokamery a zvuk aplikace.

Pokud jsou nějaké zadané, neurčené parametry budou ve výchozím nastavení false.

Volitelné parametry (pouze HoloLens 2)

• RenderFromCamera: vykreslení z perspektivy fotoaparátu nebo videokamery: true nebo false (výchozí hodnota je true)
• vstab: povolení stabilizace videa: true nebo false (výchozí hodnota je false)
• vstabbuffer: latence vyrovnávací paměti pro stabilizaci videa: 0 až 30 snímků (výchozí hodnota je 15 snímků)

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

Datový proud 1280 × 720p 30 snímků za sekundu 5Mbit.

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

Datový proud 1280 × 720p 30 snímků za sekundu 5Mbit.

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

Datový proud 854 × 480p 30 snímků za sekundu 2,5 Mb/ s.

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

Datový proud 15 snímků za sekundu 0,6 Mb/s 428 × 240p.

Sítě

/api/networking/ipconfig (GET)

Získá aktuální konfiguraci IP adresy.

Informace o operačním systému

/api/os/info (GET)

Získá informace o operačním systému.

/api/os/machinename (GET)

Získá název počítače.

/api/os/název_počítače (POST)

Nastaví název počítače.

Parametry

• name: Nový název počítače s kódováním hex64 pro nastavení na

Řízení simulace vnímání

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

Získá režim simulace.

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

Nastaví režim simulace.

Parametry

• mode: režim simulace: výchozí, simulace, vzdálený, starší

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

Odstranění datového proudu ovládacího prvku

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

Otevřete připojení WebSocket pro řídicí datový proud.

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

Vytvořte řídicí stream (vyžaduje se priorita) nebo publikujte data do vytvořeného datového proudu (vyžaduje se streamId). Očekává se, že publikovaná data budou typu application/octet-stream.

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

Vyžádejte si stream videa simulace obsahující obsah vykreslený na systémovém displeji v režimu simulace. Na začátku se odešle hlavička popisovače jednoduchého formátu následovaná texturami zakódovanými jako H.264, před kterými bude záhlaví udávající oční index a velikost textury.

Přehrávání simulace vnímání

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

Odstranění nahrávky

Parametry

• recording: Název nahrávky, která se má odstranit.

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

Nahrajte záznam.

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

Získejte všechny nahrávky.

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

Získá aktuální stav přehrávání nahrávky.

Parametry

• recording: Název nahrávky.

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

Uvolnění záznamu

Parametry

• recording: Název nahrávky, která se má uvolnit.

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

Načtěte záznam.

Parametry

• recording: Název záznamu, který se má načíst.

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

Získejte všechny načtené nahrávky.

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

Pozastavit záznam.

Parametry

• recording: Název nahrávky.

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

Přehrajte záznam.

Parametry

• recording: Název nahrávky.

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

Zastavte záznam.

Parametry

• recording: Název nahrávky.

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

Získejte typy dat v načteném záznamu.

Parametry

• recording: Název nahrávky.

Záznam simulace vnímání

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

Spusťte záznam. Najednou může být aktivní jenom jedna nahrávka. Jedna z těchto možností musí být nastavená: hlava, ruce, prostorové mapování nebo prostředí.

Parametry

• head: Pokud chcete zaznamenávat hlavní data, nastavte na hodnotu 1.
• ruce: Pokud chcete zaznamenávat data rukou, nastavte na hodnotu 1.
• spatialMapping: Pokud chcete zaznamenat prostorové mapování, nastavte na hodnotu 1.
• prostředí: Pokud chcete zaznamenávat data prostředí, nastavte na hodnotu 1.
• name: Název nahrávky.
• singleSpatialMappingFrame: Nastavením na hodnotu 1 zaznamenáte pouze jeden rámec prostorového mapování.

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

Získání stavu záznamu

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

Zastavte aktuální záznam. Záznam se vrátí jako soubor.

Data výkonu

/api/resourcemanager/processes (GET)

Vrátí seznam spuštěných procesů s podrobnostmi.

Vrácení dat

• JSON se seznamem procesů a podrobnostmi pro jednotlivé procesy

/api/resourcemanager/systemperf (GET)

Vrátí statistiky výkonu systému (vstupně-výstupní operace čtení a zápisu, statistiky paměti atd.

Vrácení dat

• JSON se systémovými informacemi: procesor, GPU, paměť, síť, vstupně-výstupní operace

Napájení

/api/power/battery (GET)

Získá aktuální stav baterie.

/api/power/state (GET)

Zkontroluje, jestli je systém ve stavu nízké spotřeby.

Vzdálené řízení

/api/control/restart (POST)

Restartuje cílové zařízení.

/api/control/shutdown (POST)

Vypne cílové zařízení.

Správce úloh

/api/taskmanager/app (DELETE)

Zastaví moderní aplikaci.

Parametry

• package: Úplný název balíčku aplikace v kódování hex64
• forcestop: Vynucení zastavení všech procesů (=yes)

/api/taskmanager/app (POST)

Spustí moderní aplikaci.

Parametry

• appid: PRAID spuštění aplikace, kódování hex64
• package: Úplný název balíčku aplikace v kódování hex64

Správa Wi-Fi

/api/wifi/interfaces (GET)

Vytvoří výčet rozhraní bezdrátové sítě.

Vrácení dat

• Seznam bezdrátových rozhraní s podrobnostmi (GUID, popis atd.)

/api/wifi/network (DELETE)

Odstraní profil přidružený k síti v zadaném rozhraní.

Parametry

• interface: identifikátor GUID síťového rozhraní
• profile: název profilu

/api/wifi/networks (GET)

Vytvoří výčet bezdrátových sítí v zadaném síťovém rozhraní.

Parametry

• interface: identifikátor GUID síťového rozhraní

Vrácení dat

• Seznam bezdrátových sítí nalezených v síťovém rozhraní s podrobnostmi

/api/wifi/síť (POST)

Připojí nebo se odpojí k síti v zadaném rozhraní.

Parametry

• interface: identifikátor GUID síťového rozhraní
• ssid: ssid, hex64 kódování, pro připojení k
• op: připojení nebo odpojení
• createprofile: yes or no
• key: sdílený klíč, hex64 kódovaný

Windows Performance Recorder

/api/wpr/customtrace (POST)

Nahraje profil WPR a spustí trasování pomocí nahraného profilu.

Datová část

• text http vyhovující více částem

Vrácení dat

• Vrátí stav relace WPR.

/api/wpr/status (GET)

Načte stav relace WPR.

Vrácení dat

• Stav relace WPR.

/api/wpr/trace (GET)

Zastaví relaci trasování WPR (performance).

Vrácení dat

• Vrátí trasovací soubor ETL.

/api/wpr/trace (POST)

Spustí relaci trasování WPR (performance).

Parametry

• profile: Název profilu. Dostupné profily jsou uložené v souboru perfprofiles/profiles.json.

Vrácení dat

• Při spuštění vrátí stav relace WPR.

Viz také

• Použití portálu zařízení s Windows
• Referenční informace k základnímu rozhraní API portálu Device Portal (UPW)