Naslaginformatie over de API van de apparaatportal

  • Artikel

Alles in de Windows-apparaatportal is gebouwd op REST API's die u kunt gebruiken om toegang te krijgen tot de gegevens en uw apparaat programmatisch te beheren.

App-implementatie

/api/app/packagemanager/package (DELETE)

Hiermee verwijdert u een app.

Parameters

  • package: de bestandsnaam van het pakket dat moet worden verwijderd.

/api/app/packagemanager/package (POST)

Hiermee installeert u een app.

Parameters

  • package: Bestandsnaam van het pakket dat moet worden geïnstalleerd.

Nettolading

  • meerdelige http-hoofdtekst

/api/app/packagemanager/packages (GET)

Hiermee haalt u de lijst met geïnstalleerde apps op het systeem op. Bevat details.

Gegevens retourneren

  • Lijst met geïnstalleerde pakketten met details

/api/app/packagemanager/state (GET)

Hiermee wordt de status van de app-installatie in uitvoering opgeslagen.

Dumpverzameling

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

Hiermee wordt het verzamelen van crashdumps voor een sideload-app uitgeschakeld.

Parameters

  • packageFullName: pakketnaam

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

Hiermee worden instellingen opgehaald voor het verzamelen van crashdumps voor sideload-apps.

Parameters

  • packageFullName: pakketnaam

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

Hiermee worden instellingen voor dumpbeheer voor een sideload-app ingeschakeld en ingesteld.

Parameters

  • packageFullName: pakketnaam

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

Hiermee verwijdert u een crashdump voor een sideload-app.

Parameters

  • packageFullName: pakketnaam
  • fileName: naam van dumpbestand

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

Hiermee wordt een crashdump opgehaald voor een sideload-app.

Parameters

  • packageFullName: pakketnaam
  • fileName: naam van dumpbestand

Gegevens retourneren

  • Dumpbestand. Inspecteer met WinDbg of Visual Studio.

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

Retourneert een lijst met alle crashdumps voor sideloading-apps.

Gegevens retourneren

  • Lijst met crashdumps per geladen app

ETW

/api/etw/providers (GET)

Inventariseert geregistreerde providers.

Gegevens retourneren

  • Lijst met providers, beschrijvende naam en GUID

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

Maakt een realtime ETW-sessie; beheerd via een websocket.

Gegevens retourneren

  • ETW-gebeurtenissen van de ingeschakelde providers

Holografisch besturingssysteem

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

Retourneert een lijst met HoloLens-specifieke ETW-providers die niet zijn geregistreerd bij het systeem.

/api/holographic/os/services (GET)

Retourneert de statussen van alle services die worden uitgevoerd.

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

Haalt de opgeslagen IPD (Interpupillary distance) op in millimeters.

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

Hiermee stelt u de IPD in.

Parameters

  • ipd: nieuwe IPD-waarde die moet worden ingesteld in millimeters

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

Hiermee haalt u HTTPS-vereisten voor de apparaatportal op.

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

Hiermee stelt u HTTPS-vereisten voor de apparaatportal in.

Parameters

  • vereist: ja, nee of standaard

Holografische waarneming

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

Accepteert WebSocket-upgrades en voert een perceptieclient uit die updates verzendt met 30 fps.

Parameters

  • clientmode: 'actief' dwingt visuele trackingmodus af wanneer deze niet passief kan worden ingesteld

Holografische thermische

Wanneer u deze thermische API's gebruikt, raadpleegt u het artikel over het beheren van energie en thermische functies .

/api/holographic/thermal/stage (GET)

Haal de thermische fase van het apparaat op (0 normaal, 1 warm, 2 kritiek).

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

Open een websocket (of voer één HTTP GET-query uit) en retourneert een lijst met objecten die het volgende bevatten:

  • IsSuppressed - Identificeren of een bepaald randapparaat beperkingen heeft onderdrukt
  • Level - Meest recente thermische risicobeperkingsniveau voor dit randapparaat
  • Masker - Masker van dit randapparaat
  • ThermalScore - Meest recente thermische score voor dit randapparaat

Objecten worden benoemd op randapparaatnaam (voorbeeld: batterij)

/api/holographic/thermal/setMitigationLevel (POST)

Het risicobeperkingsniveau wijzigen dat wordt gerapporteerd voor een bepaald randapparaat

Parameters

  • masker: bitmasker met één bit ingesteld voor het randapparaat van belang (zie PowerThermalPeripheralFlags voor meer informatie)
  • niveau: nieuw te gebruiken niveau (0-3)

/api/holographic/thermal/setThermalScore (POST)

De thermische score wijzigen die wordt gerapporteerd voor een bepaald randapparaat

Parameters

  • masker: bitmasker met één bit ingesteld voor het randapparaat van belang (zie PowerThermalPeripheralFlags voor meer informatie)
  • thermalScore: nieuwe thermische score te gebruiken (100-0)

Kaartbeheer

/api/holographic/mapmanager/mapFiles (GET)

Hiermee haalt u de lijst met de beschikbare kaartbestanden (.mapx) op.

/api/holographic/mapmanager/anchorFiles (GET)

Hiermee haalt u de lijst met beschikbare ankerbestanden (.ancx) op.

/api/holographic/mapmanager/srdbFiles (GET)

Hiermee haalt u de lijst met beschikbare databasebestanden voor ruimtelijke reconstructie (.srdb) op.

/api/holographic/mapmanager/getanchors (GET)

Hiermee haalt u de lijst met persistente ankers voor de huidige gebruiker op.

Bestanden downloaden/uploaden/verwijderen

/api/holographic/mapmanager/download (GET)

Hiermee downloadt u een databasebestand voor kaart-, anker- of ruimtelijke reconstructie. Het bestand moet eerder zijn geüpload of geëxporteerd.

Parameters

  • FileName: de naam van het bestand dat moet worden gedownload.

Voorbeeld:

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

/api/holographic/mapmanager/upload (POST)

Uploadt een databasebestand voor kaart-, anker- of ruimtelijke reconstructie. Zodra een bestand is geüpload, kan het later worden geïmporteerd en gebruikt door het systeem.

Parameters

  • file: naam van het bestand dat u wilt uploaden.

Voorbeeld:

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)

Hiermee verwijdert u een databasebestand voor kaart-, anker- of ruimtelijke reconstructie. Het bestand moet eerder zijn geüpload of geëxporteerd.

Parameters

  • FileName: de naam van het bestand dat moet worden verwijderd.

Voorbeeld:

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

Exporteren

/api/holographic/mapmanager/export (POST)

Hiermee exporteert u de kaart die momenteel door het systeem wordt gebruikt. Zodra het is geëxporteerd, kan het worden gedownload.

Voorbeeld:

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

/api/holographic/mapmanager/exportanchors (POST)

Hiermee exporteert u de kaart die momenteel door het systeem wordt gebruikt. Zodra het is geëxporteerd, kan het worden gedownload. Voorbeeld:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Hiermee exporteert u de kaart en ankers die momenteel door het systeem worden gebruikt. Zodra ze zijn geëxporteerd, kunnen ze worden gedownload. Voorbeeld:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Hiermee exporteert u de kaart- en ruimtelijke reconstructiedatabase die momenteel door het systeem worden gebruikt. Zodra ze zijn geëxporteerd, kunnen ze worden gedownload.

Voorbeeld:

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

Importeren

/api/holographic/mapmanager/import (POST)

Geeft aan het systeem aan welke toewijzing moet worden gebruikt. Kan worden aangeroepen voor bestanden die zijn geëxporteerd of geüpload.

Parameters

  • FileName: naam van de kaart die moet worden gebruikt.

Voorbeeld:

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

/api/holographic/mapmanager/importanchors (POST)

Geeft aan het systeem aan welke ankers moeten worden gebruikt. Kan worden aangeroepen voor bestanden die zijn geëxporteerd of geüpload.

Parameters

  • FileName: naam van de ankers die moeten worden gebruikt.

Voorbeeld:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Geeft aan het systeem aan welke ruimtelijke reconstructiedatabase moet worden gebruikt. Kan worden aangeroepen voor bestanden die zijn geëxporteerd of geüpload.

Parameters

  • FileName: naam van de ruimtelijke toewijzingsdatabase die moet worden gebruikt.

Voorbeeld:

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

Anders

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Stel het systeem de kaart, ankers en ruimtelijke reconstructiedatabase opnieuw in.

Voorbeeld:

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

/api/holographic/mapmanager/status (GET)

Hiermee haalt u de status van het systeem op, inclusief welke kaart-, anker- en ruimtelijke reconstructiedatabasebestanden voor het laatst zijn geïmporteerd.

Mixed Reality Capture

/api/holographic/mrc/file (GET)

Hiermee downloadt u een mixed reality-bestand van het apparaat. Gebruik de queryparameter op=stream voor streaming.

Parameters

  • bestandsnaam: naam, hex64 gecodeerd, van het videobestand dat moet worden opgehaald
  • op: stream

/api/holographic/mrc/file (DELETE)

Hiermee verwijdert u een mixed reality-opname van het apparaat.

Parameters

  • bestandsnaam: naam, hex64 gecodeerd, van het bestand dat u wilt verwijderen

/api/holographic/mrc/files (GET)

Retourneert de lijst met mixed reality-bestanden die zijn opgeslagen op het apparaat.

/api/holographic/mrc/photo (POST)

Maakt een mixed reality-foto en maakt een bestand op het apparaat.

Parameters

  • holo: hologrammen vastleggen: true of false (standaard ingesteld op false)
  • hw: vastleggen PV-camera: waar of onwaar (standaard ingesteld op onwaar)
  • RenderFromCamera: (alleen HoloLens 2) weergeven vanuit het perspectief van de foto-/videocamera: waar of onwaar (standaard ingesteld op true)

/api/holographic/mrc/settings (GET)

Hiermee haalt u de standaardinstellingen voor het vastleggen van mixed reality op.

/api/holographic/mrc/settings (POST)

Hiermee stelt u de standaardinstellingen voor het vastleggen van mixed reality in. Sommige van deze instellingen worden toegepast op de MRC-foto- en video-opname van het systeem.

/api/holographic/mrc/status (GET)

Hiermee haalt u de status van mixed reality-opname op binnen de Windows-apparaatportal.

Antwoord

Het antwoord bevat een JSON-eigenschap die aangeeft of Windows Device Portal video opneemt of niet.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Hiermee haalt u de miniatuurafbeelding voor het opgegeven bestand op.

Parameters

  • bestandsnaam: naam, hex64 gecodeerd, van het bestand waarvoor de miniatuur wordt aangevraagd

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

Hiermee start u een opname van mixed reality.

Parameters

  • holo: hologrammen vastleggen: waar of onwaar (standaard ingesteld op onwaar)
  • pv: capture PV camera: true of false (standaard ingesteld op false)
  • microfoon: opnamemicrofoon: true of false (standaard ingesteld op false)
  • loopback: app-audio vastleggen: waar of onwaar (standaard ingesteld op onwaar)
  • RenderFromCamera: (alleen HoloLens 2) weergeven vanuit het perspectief van de foto-/videocamera: waar of onwaar (standaard ingesteld op true)
  • vstab: (alleen HoloLens 2) videostabilisatie inschakelen: waar of onwaar (standaard ingesteld op true)
  • vstabbuffer: (alleen HoloLens 2) latentie van videostabilisatiebuffer: 0 tot 30 frames (standaard 15 frames)

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

Stopt de huidige mixed reality-opname.

Mixed Reality streamen

Waarschuwing

Vanwege loopback-isolatie kunt u geen verbinding maken met streaming van mixed reality vanuit een app op een apparaat.

HoloLens ondersteunt live preview van mixed reality via gesegmenteerde download van een gefragmenteerde mp4.

Mixed reality-streams delen dezelfde set parameters om te bepalen wat er wordt vastgelegd:

  • holo: hologrammen vastleggen: waar of onwaar
  • hw: vastleggen PV camera: waar of onwaar
  • microfoon: opnamemicrofoon: waar of onwaar
  • loopback: app-audio vastleggen: waar of onwaar

Als geen van deze gegevens is opgegeven, worden hologrammen, foto-/videocamera's en app-audio vastgelegd.

Als er een zijn opgegeven, worden de niet-opgegeven parameters standaard ingesteld op false

Optionele parameters (alleen HoloLens 2)

  • RenderFromCamera: weergeven vanuit het perspectief van foto/videocamera: waar of onwaar (standaard ingesteld op true)
  • vstab: videostabilisatie inschakelen: waar of onwaar (standaard ingesteld op onwaar)
  • vstabbuffer: latentie van videostabilisatiebuffer: 0 tot 30 frames (standaard 15 frames)

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

Een 1280x720p 30fps 5Mbit stream.

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

Een 1280x720p 30fps 5Mbit stream.

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

Een 854x480p 30fps 2,5-bits stream.

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

Een 428x240p 15fps 0,6Mbit stream.

Netwerken

/api/networking/ipconfig (GET)

Hiermee haalt u de huidige IP-configuratie op.

Informatie over het besturingssysteem

/api/os/info (GET)

Hiermee haalt u informatie over het besturingssysteem op.

/api/os/machinename (GET)

Hiermee haalt u de computernaam op.

/api/os/machinename (POST)

Hiermee stelt u de computernaam in.

Parameters

  • naam: nieuwe computernaam, hex64 gecodeerd, om in te stellen op

Waarnemingssimulatiebesturing

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

Hiermee haalt u de simulatiemodus op.

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

Hiermee stelt u de simulatiemodus in.

Parameters

  • modus: simulatiemodus: standaard, simulatie, extern, verouderd

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

Een controlestroom verwijderen.

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

Open een WebSocket-verbinding voor een besturingsstroom.

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

Maak een controlestroom (prioriteit is vereist) of post gegevens naar een gemaakte stream (streamId vereist). Geposte gegevens zijn naar verwachting van het type 'application/octet-stream'.

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

Vraag een simulatievideostream aan met de inhoud die wordt weergegeven in de systeemweergave in de modus Simulatie. In eerste instantie wordt een eenvoudige indelingsdescriptorheader verzonden, gevolgd door H.264-gecodeerde patronen, waarbij elk wordt voorafgegaan door een koptekst die de oogindex en de grootte van het patroon aangeeft.

Afspelen van waarnemingssimulatie

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

Een opname verwijderen.

Parameters

  • opname: de naam van de opname die moet worden verwijderd.

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

Upload een opname.

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

Alle opnamen ophalen.

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

De huidige afspeelstatus van een opname ophalen.

Parameters

  • recording: Naam van opname.

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

Een opname uitladen.

Parameters

  • opname: de naam van de opname die moet worden uitgeladen.

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

Een opname laden.

Parameters

  • opname: de naam van de opname die moet worden geladen.

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

Alle geladen opnamen ophalen.

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

Een opname onderbreken.

Parameters

  • recording: Naam van opname.

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

Een opname afspelen.

Parameters

  • recording: naam van de opname.

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

Een opname stoppen.

Parameters

  • recording: naam van de opname.

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

De typen gegevens in een geladen opname ophalen.

Parameters

  • recording: naam van de opname.

Opname van waarnemingssimulatie

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

Start een opname. Er kan slechts één opname tegelijk actief zijn. Een van deze moet worden ingesteld: hoofd, handen, spatialMapping of omgeving.

Parameters

  • head: stel in op 1 om hoofdgegevens vast te leggen.
  • hands: stel in op 1 om handgegevens vast te leggen.
  • spatialMapping: stel in op 1 om ruimtelijke toewijzing vast te leggen.
  • omgeving: stel in op 1 om omgevingsgegevens vast te leggen.
  • name: naam van de opname.
  • singleSpatialMappingFrame: stel in op 1 om slechts één frame voor ruimtelijke toewijzing vast te leggen.

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

Opnamestatus ophalen.

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

Stop de huidige opname. De opname wordt geretourneerd als een bestand.

Prestatiegegevens

/api/resourcemanager/processes (GET)

Retourneert de lijst met actieve processen met details.

Gegevens retourneren

  • JSON met een lijst met processen en details voor elk proces

/api/resourcemanager/systemperf (GET)

Retourneert prestatiestatistieken van het systeem (I/O lezen/schrijven, geheugenstatistieken, enzovoort).

Gegevens retourneren

  • JSON met systeemgegevens: CPU, GPU, geheugen, netwerk, I/O

Stroom

/api/power/battery (GET)

Hiermee haalt u de huidige batterijstatus op.

/api/power/state (GET)

Controleert of het systeem een energiearme status heeft.

Afstandsbediening

/api/control/restart (POST)

Start het doelapparaat opnieuw op.

/api/control/shutdown (POST)

Hiermee wordt het doelapparaat afgesloten.

Taakbeheer

/api/taskmanager/app (DELETE)

Stopt een moderne app.

Parameters

  • package: Volledige naam van het app-pakket, hex64 gecodeerd
  • forcestop: forceren dat alle processen stoppen (=ja)

/api/taskmanager/app (POST)

Een moderne app starten

Parameters

  • appid: PRAID van de app die moet worden gestart, hex64 gecodeerd
  • package: Volledige naam van het app-pakket, hex64 gecodeerd

Wi-Fi-beheer

/api/wifi/interfaces (GET)

Opsomming van draadloze netwerkinterfaces.

Gegevens retourneren

  • Lijst met draadloze interfaces met details (GUID, beschrijving, enzovoort)

/api/wifi/network (DELETE)

Hiermee verwijdert u een profiel dat is gekoppeld aan een netwerk op een opgegeven interface.

Parameters

  • interface: netwerkinterface-GUID
  • profiel: profielnaam

/api/wifi/networks (GET)

Opsomming van draadloze netwerken op de opgegeven netwerkinterface.

Parameters

  • interface: netwerkinterface-GUID

Gegevens retourneren

  • Lijst met draadloze netwerken op de netwerkinterface met details

/api/wifi/network (POST)

Maakt verbinding met een netwerk of verbreekt de verbinding met een netwerk op de opgegeven interface.

Parameters

  • interface: netwerkinterface-GUID
  • ssid: ssid, hex64 gecodeerd, om verbinding mee te maken
  • op: verbinding maken of de verbinding verbreken
  • createprofile: ja of nee
  • sleutel: gedeelde sleutel, hex64 gecodeerd

Windows Performance Recorder

/api/wpr/customtrace (POST)

Uploadt een WPR-profiel en begint met traceren met behulp van het geüploade profiel.

Nettolading

  • HTTP-hoofdtekst met meerdere onderdelen

Gegevens retourneren

  • Retourneert de STATUS van de WPR-sessie.

/api/wpr/status (GET)

Haalt de status van de WPR-sessie op

Gegevens retourneren

  • WPR-sessiestatus.

/api/wpr/trace (GET)

Stopt een WPR-traceringssessie (prestaties).

Gegevens retourneren

  • Retourneert het ETL-traceringsbestand

/api/wpr/trace (POST)

Start een WPR-traceringssessie (prestaties).

Parameters

  • profile: Profielnaam. Beschikbare profielen worden opgeslagen in perfprofiles/profiles.json

Gegevens retourneren

  • Bij het starten retourneert de WPR-sessiestatus.

Zie ook