API-referens för enhetsportalen

  • Artikel

Allt i Windows-enhetsportalen bygger på REST API:er som du kan använda för att komma åt data och styra enheten programmatiskt.

Appdistribution

/api/app/packagemanager/package (DELETE)

Avinstallerar en app.

Parametrar

  • package: Filnamnet på paketet som ska avinstalleras.

/api/app/packagemanager/package (POST)

Installerar en app.

Parametrar

  • package: Filnamnet på paketet som ska installeras.

Nyttolast

  • http-brödtext i flera delar

/api/app/packagemanager/packages (GET)

Hämtar listan över installerade appar i systemet. Innehåller information.

Returnera data

  • Lista över installerade paket med information

/api/app/packagemanager/state (GET)

Hämtar status för pågående appinstallation.

Dumpsamling

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

Inaktiverar kraschdumpsamling för en separat inläst app.

Parametrar

  • packageFullName: paketnamn

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

Hämtar inställningar för kraschdumpsamling med separat inlästa appar.

Parametrar

  • packageFullName: paketnamn

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

Aktiverar och ställer in inställningar för dumpkontroll för en separat inläst app.

Parametrar

  • packageFullName: paketnamn

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

Tar bort en kraschdump för en separat inläst app.

Parametrar

  • packageFullName: paketnamn
  • fileName: dumpfilnamn

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

Hämtar en kraschdump för en separat inläst app.

Parametrar

  • packageFullName: paketnamn
  • fileName: dumpfilnamn

Returnera data

  • Dumpfil. Inspektera med WinDbg eller Visual Studio.

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

Returnerar en lista över alla kraschdumpar för separat inlästa appar.

Returnera data

  • Lista över kraschdumpar per separat inläst app

ETW

/api/etw/providers (GET)

Räknar upp registrerade providers.

Returnera data

  • Lista över leverantörer, eget namn och GUID

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

Skapar en ETW-session i realtid. hanteras via en websocket.

Returnera data

  • ETW-händelser från de aktiverade leverantörerna

Holografiskt operativsystem

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

Returnerar en lista över HoloLens-specifika ETW-providers som inte är registrerade i systemet.

/api/holographic/os/services (GET)

Returnerar tillstånden för alla tjänster som körs.

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

Hämtar lagrad IPD (Interpupillary distance) i millimeter.

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

Anger IPD:en.

Parametrar

  • ipd: Nytt IPD-värde som ska anges i millimeter

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

Hämtar HTTPS-krav för enhetsportalen.

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

Anger HTTPS-krav för enhetsportalen.

Parametrar

  • obligatoriskt: ja, nej eller standard

Holografisk uppfattning

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

Accepterar WebSocket-uppgraderingar och kör en perceptionsklient som skickar uppdateringar på 30 fps.

Parametrar

  • clientmode: "aktiv" tvingar det visuella spårningsläget när det inte kan upprättas passivt

Holografisk termisk

När du använder dessa termiska API:er refererar du till artikeln om att hantera ström och termisk energi.

/api/holographic/thermal/stage (GET)

Hämta enhetens termiska fas (0 normal, 1 varm, 2 kritisk).

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

Öppna en websocket (eller gör en enda HTTP GET-fråga) och returnera en lista med objekt som innehåller följande:

  • IsSuppressed – Identifiera om en viss kringutrustning har åtgärder undertryckta
  • Nivå – senaste termiska riskreduceringsnivån för den här kringutrustningen
  • Mask – Mask för den här kringutrustningen
  • ThermalScore – senaste termiska poängen för denna kringutrustning

Objekt namnges efter kringutrustningsnamn (exempel: Batteri)

/api/holographic/thermal/setMitigationLevel (POST)

Ändra den åtgärdsnivå som rapporteras för en viss kringutrustning

Parametrar

  • mask: bitmask med en bit inställd för kringutrustningen (mer information finns i PowerThermalPeripheralFlags )
  • nivå: ny nivå att använda (0–3)

/api/holographic/thermal/setThermalScore (POST)

Ändra termisk poäng som rapporteras för en viss kringutrustning

Parametrar

  • mask: bitmask med enkel bit inställd för kringutrustning av intresse (mer information finns i PowerThermalPeripheralFlags )
  • thermalScore: ny termisk poäng att använda (100-0)

Karthanteraren

/api/holographic/mapmanager/mapFiles (GET)

Hämtar listan över tillgängliga kartfiler (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Hämtar listan över tillgängliga fästpunktsfiler (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Hämtar listan över tillgängliga databasfiler för rumslig återuppbyggnad (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Hämtar listan över beständiga fästpunkter för den aktuella användaren.

Ladda ned/ladda upp/ta bort filer

/api/holographic/mapmanager/download (GET)

Laddar ned en databasfil för karta, fästpunkt eller rumslig återuppbyggnad. Filen måste ha laddats upp eller exporterats tidigare.

Parametrar

  • FileName: Namnet på filen som ska laddas ned.

Exempel:

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

/api/holographic/mapmanager/upload (POST)

Laddar upp en databasfil för karta, fästpunkt eller rumslig återuppbyggnad. När en fil har laddats upp kan den senare importeras och användas av systemet.

Parametrar

  • file: Namnet på filen som ska laddas upp.

Exempel:

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)

Tar bort en databasfil för karta, fästpunkt eller rumslig återuppbyggnad. Filen måste ha laddats upp eller exporterats tidigare.

Parametrar

  • FileName: Namnet på filen som ska tas bort.

Exempel:

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

Exportera

/api/holographic/mapmanager/export (POST)

Exporterar den karta som för närvarande används av systemet. När den har exporterats kan den laddas ned.

Exempel:

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

/api/holographic/mapmanager/exportanchors (POST)

Exporterar den karta som för närvarande används av systemet. När den har exporterats kan den laddas ned. Exempel:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Exporterar kartan och fästpunkterna som för närvarande används av systemet. När de har exporterats kan de laddas ned. Exempel:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Exporterar kartdatabasen och databasen för rumslig återuppbyggnad som för närvarande används av systemet. När de har exporterats kan de laddas ned.

Exempel:

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

Importera

/api/holographic/mapmanager/import (POST)

Anger för systemet vilken karta som ska användas. Kan anropas för filer som har exporterats eller laddats upp.

Parametrar

  • FileName: Namnet på den mappning som ska användas.

Exempel:

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

/api/holographic/mapmanager/importanchors (POST)

Anger för systemet vilka fästpunkter som ska användas. Kan anropas för filer som har exporterats eller laddats upp.

Parametrar

  • FileName: Namnet på fästpunkterna som ska användas.

Exempel:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Anger för systemet vilken rumslig återuppbyggnadsdatabas som ska användas. Kan anropas för filer som har exporterats eller laddats upp.

Parametrar

  • FileName: Namnet på den databas för rumslig mappning som ska användas.

Exempel:

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

Övrigt

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Återställ systemet till kartan, fästpunkterna och databasen för rumslig återuppbyggnad.

Exempel:

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

/api/holographic/mapmanager/status (GET)

Hämtar systemets status, inklusive vilka mappnings-, fästpunkts- och spatial återuppbyggnadsdatabasfiler som senast importerades.

Mixed Reality Capture

/api/holographic/mrc/file (GET)

Laddar ned en mixed reality-fil från enheten. Använd op=stream-frågeparametern för strömning.

Parametrar

  • filename: Name, hex64 encoded, of the video file to get
  • op: stream

/api/holographic/mrc/file (DELETE)

Tar bort en mixed reality-inspelning från enheten.

Parametrar

  • filename: Name, hex64 encoded, of the file to delete

/api/holographic/mrc/files (GET)

Returnerar listan över mixed reality-filer som lagras på enheten.

/api/holographic/mrc/photo (POST)

Tar ett foto för mixad verklighet och skapar en fil på enheten.

Parametrar

  • holo: avbilda hologram: sant eller falskt (standardvärdet är falskt)
  • pv: avbilda PV-kamera: sant eller falskt (standardvärdet är falskt)
  • RenderFromCamera: (endast HoloLens 2) rendera ur foto-/videokamerans perspektiv: sant eller falskt (standardvärdet är sant)

/api/holographic/mrc/settings (GET)

Hämtar standardinställningarna för mixed reality-avbildning.

/api/holographic/mrc/settings (POST)

Anger standardinställningarna för mixed reality-avbildning. Några av de här inställningarna tillämpas på systemets MRC-foto- och videoinspelning.

/api/holographic/mrc/status (GET)

Hämtar tillståndet för mixed reality-avbildning i Windows-enhetsportalen.

Svarsåtgärder

Svaret innehåller en JSON-egenskap som anger om Windows-enhetsportalen spelar in video eller inte.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Hämtar miniatyrbilden för den angivna filen.

Parametrar

  • filename: Namn, hex64-kodat, för filen som miniatyrbilden begärs för

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

Startar en mixed reality-inspelning.

Parametrar

  • holo: avbilda hologram: sant eller falskt (standardvärdet är falskt)
  • pv: avbilda PV-kamera: sant eller falskt (standardvärdet är falskt)
  • mic: avbilda mikrofon: sant eller falskt (standardvärdet är falskt)
  • loopback: spela in appljud: sant eller falskt (standardvärdet är falskt)
  • RenderFromCamera: (endast HoloLens 2) rendera ur foto-/videokamerans perspektiv: sant eller falskt (standardvärdet är sant)
  • vstab: (endast HoloLens 2) aktivera videostabilisering: sant eller falskt (standardvärdet är sant)
  • vstabbuffer: (endast HoloLens 2) svarstid för videostabiliseringsbuffert: 0 till 30 bildrutor (standardvärdet är 15 bildrutor)

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

Stoppar den aktuella mixed reality-inspelningen.

Mixed Reality direktuppspelning

Varning

På grund av loopback-isolering kan du inte ansluta till mixed reality-strömning inifrån en app på en enhet.

HoloLens stöder live-förhandsversion av mixad verklighet via segmenterad nedladdning av en fragmenterad mp4.

Mixed Reality-strömmar delar samma uppsättning parametrar för att styra vad som samlas in:

  • holo: avbilda hologram: sant eller falskt
  • pv: fånga PV-kamera: sant eller falskt
  • mic: fånga mikrofon: sant eller falskt
  • loopback: spela in appljud: sant eller falskt

Om inget av dessa anges registreras hologram, foto-/videokamera och appljud.

Om några anges kommer de ospecificerade parametrarna som standard att vara false

Valfria parametrar (endast HoloLens 2)

  • RenderFromCamera: rendera ur foto-/videokamerans perspektiv: sant eller falskt (standardvärdet är true)
  • vstab: aktivera videostabilisering: sant eller falskt (standardvärdet är falskt)
  • vstabbuffer: svarstid för videostabiliseringsbuffert: 0 till 30 bildrutor (standardvärdet är 15 bildrutor)

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

En 1280x720p 30fps 5Mbit-ström.

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

En 1280x720p 30fps 5Mbit-ström.

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

En 854x480p 30fps 2.5Mbit ström.

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

En 428x240p 15fps 0.6Mbit ström.

Nätverk

/api/networking/ipconfig (GET)

Hämtar den aktuella IP-konfigurationen.

OS-information

/api/os/info (GET)

Hämtar information om operativsystemet.

/api/os/machinename (GET)

Hämtar datornamnet.

/api/os/machinename (POST)

Anger datornamnet.

Parametrar

  • name: Nytt datornamn, hex64-kodat, som ska anges till

Kontroll av perceptionssimulering

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

Hämtar simuleringsläget.

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

Anger simuleringsläget.

Parametrar

  • mode: simuleringsläge: standard, simulering, fjärr, äldre

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

Ta bort en kontrollström.

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

Öppna en WebSocket-anslutning för en kontrollström.

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

Skapa en kontrollström (prioritet krävs) eller publicera data till en skapad dataström (streamId krävs). Publicerade data förväntas vara av typen "application/octet-stream".

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

Begär en simuleringsvideoström som innehåller innehållet som återges på systemskärmen när det är i simuleringsläge. En enkel formatbeskrivningsrubrik skickas inledningsvis, följt av H.264-kodade texturer, där var och en föregås av en rubrik som anger ögonindex och strukturstorlek.

Uppspelning av perceptionssimulering

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

Ta bort en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen som ska tas bort.

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

Ladda upp en inspelning.

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

Hämta alla inspelningar.

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

Hämta det aktuella uppspelningstillståndet för en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen.

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

Ta bort en inspelning.

Parametrar

  • inspelning: Namn på inspelning som ska tas bort.

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

Läs in en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen som ska läsas in.

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

Hämta alla inlästa inspelningar.

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

Pausa en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen.

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

Spela upp en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen.

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

Stoppa en inspelning.

Parametrar

  • inspelning: Namnet på inspelningen.

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

Hämta datatyperna i en inläst inspelning.

Parametrar

  • inspelning: Namnet på inspelningen.

Inspelning av perceptionssimulering

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

Starta en inspelning. Endast en enda inspelning kan vara aktiv samtidigt. Ett av dessa måste anges: huvud, händer, spatialMapping eller miljö.

Parametrar

  • head: Ange till 1 för att registrera huvuddata.
  • händer: Ange till 1 för att registrera handdata.
  • spatialMapping: Ange till 1 för att registrera rumslig mappning.
  • miljö: Ange till 1 för att registrera miljödata.
  • name: Namnet på inspelningen.
  • singleSpatialMappingFrame: Ange till 1 för att endast spela in en enda ram för spatial mappning.

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

Hämta inspelningstillstånd.

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

Stoppa den aktuella inspelningen. Inspelningen returneras som en fil.

Prestandadata

/api/resourcemanager/processes (GET)

Returnerar listan över processer som körs med information.

Returnera data

  • JSON med en lista över processer och information för varje process

/api/resourcemanager/systemperf (GET)

Returnerar systemets prestandastatistik (I/O-läsning/skrivning, minnesstatistik osv.

Returnera data

  • JSON med systeminformation: CPU, GPU, Minne, Nätverk, IO

Ström

/api/power/battery (GET)

Hämtar det aktuella batteritillståndet.

/api/power/state (GET)

Kontrollerar om systemet har låg effekt.

Fjärrstyrning

/api/control/restart (POST)

Startar om målenheten.

/api/control/shutdown (POST)

Stänger av målenheten.

Aktivitetshanteraren

/api/taskmanager/app (DELETE)

Stoppar en modern app.

Parametrar

  • package: Appaketets fullständiga namn, hex64-kodat
  • forcestop: Tvinga alla processer att stoppa (=ja)

/api/taskmanager/app (POST)

Startar en modern app

Parametrar

  • appid: PRAID för appen som ska startas, hex64-kodad
  • package: Appaketets fullständiga namn, hex64-kodat

WiFi-hantering

/api/wifi/interfaces (GET)

Räknar upp trådlösa nätverksgränssnitt.

Returnera data

  • Lista över trådlösa gränssnitt med information (GUID, beskrivning osv.)

/api/wifi/network (DELETE)

Tar bort en profil som är associerad med ett nätverk i ett angivet gränssnitt.

Parametrar

  • gränssnitt: guid för nätverksgränssnitt
  • profil: profilnamn

/api/wifi/networks (GET)

Räknar upp trådlösa nätverk i det angivna nätverksgränssnittet.

Parametrar

  • gränssnitt: guid för nätverksgränssnitt

Returnera data

  • Lista över trådlösa nätverk som finns i nätverksgränssnittet med information

/api/wifi/network (POST)

Ansluter eller kopplar från till ett nätverk i det angivna gränssnittet.

Parametrar

  • gränssnitt: guid för nätverksgränssnitt
  • ssid: ssid, hex64 encoded, för att ansluta till
  • op: anslut eller koppla från
  • createprofile: ja eller nej
  • key: shared key, hex64 encoded

Windows Performance Recorder

/api/wpr/customtrace (POST)

Laddar upp en WPR-profil och börjar spåra med den uppladdade profilen.

Nyttolast

  • http-brödtext i flera delar

Returnera data

  • Returnerar WPR-sessionsstatusen.

/api/wpr/status (GET)

Hämtar status för WPR-sessionen

Returnera data

  • WPR-sessionsstatus.

/api/wpr/trace (GET)

Stoppar en WPR-spårningssession (prestanda).

Returnera data

  • Returnerar ETL-spårningsfilen

/api/wpr/trace (POST)

Startar en WPR-spårningssession (prestanda).

Parametrar

  • profil: Profilnamn. Tillgängliga profiler lagras i perfprofiles/profiles.json

Returnera data

  • Vid start returnerar WPR-sessionsstatusen.

Se även