Referenz der Geräteportal-API
Alles im Windows-Geräteportal basiert auf REST-APIs, mit denen Sie programmgesteuert auf die Daten zugreifen und Ihr Gerät steuern können.
App-Bereitstellung
/api/app/packagemanager/package (DELETE)
Deinstalliert eine App.
Parameter
- Package: Dateiname des zu deinstallierenden Pakets.
/api/app/packagemanager/package (POST)
Installiert eine App.
Parameter
- package: Dateiname des zu installierenden Pakets.
Nutzlast
- mehrteiliger http-Konformer Text
/api/app/packagemanager/packages (GET)
Ruft die Liste der installierten Apps auf dem System ab. Enthält Details.
Daten zurückgeben
- Liste der installierten Pakete mit Details
/api/app/packagemanager/state (GET)
Ruft den status der laufenden App-Installation ab.
Absturzabbildsammlung
/api/debug/dump/usermode/crashcontrol (DELETE)
Deaktiviert die Absturzabbildsammlung für eine quergeladene App.
Parameter
- packageFullName: Paketname
/api/debug/dump/usermode/crashcontrol (GET)
Ruft Einstellungen für die Absturzabbildsammlung von quergeladenen Apps ab.
Parameter
- packageFullName: Paketname
/api/debug/dump/usermode/crashcontrol (POST)
Aktiviert und legt Einstellungen für die Speicherabbildsteuerung für eine quergeladene App fest.
Parameter
- packageFullName: Paketname
/api/debug/dump/usermode/crashdump (DELETE)
Löscht ein Absturzabbild für eine quergeladene App.
Parameter
- packageFullName: Paketname
- fileName: Dumpdateiname
/api/debug/dump/usermode/crashdump (GET)
Ruft ein Absturzabbild für eine quergeladene App ab.
Parameter
- packageFullName: Paketname
- fileName: Dumpdateiname
Daten zurückgeben
- Speicherabbilddatei. Untersuchen sie mit WinDbg oder Visual Studio.
/api/debug/dump/usermode/dumps (GET)
Gibt eine Liste aller Absturzabbilder für quergeladene Apps zurück.
Daten zurückgeben
- Liste der Absturzabbilder pro seitlich geladener App
ETW
/api/etw/providers (GET)
Listet registrierte Anbieter auf.
Daten zurückgeben
- Liste der Anbieter, Anzeigename und GUID
/api/etw/session/realtime (GET/WebSocket)
Erstellt eine ETW-Sitzung in Echtzeit. über ein Websocket verwaltet.
Daten zurückgeben
- ETW-Ereignisse der aktivierten Anbieter
Holographic – Betriebssystem
/api/holographic/os/etw/customproviders (GET)
Gibt eine Liste der HoloLens-spezifischen ETW-Anbieter zurück, die nicht beim System registriert sind.
/api/holographic/os/services (GET)
Gibt den Status aller ausgeführten Dienste zurück.
/api/holographic/os/settings/ipd (GET)
Ruft die gespeicherte IPD (Interpupillary Distance) in Millimetern ab.
/api/holographic/os/settings/ipd (POST)
Legt die IPD fest.
Parameter
- ipd: Neuer IPD-Wert wird in Millimetern festgelegt
/api/holographic/os/webmanagement/settings/https (GET)
Ruft HTTPS-Anforderungen für das Geräteportal ab.
/api/holographic/os/webmanagement/settings/https (POST)
Legt HTTPS-Anforderungen für das Geräteportal fest.
Parameter
- erforderlich: Ja, Nein oder Standard
Holografische Wahrnehmung
/api/holographic/perception/client (GET/WebSocket)
Akzeptiert WebSocket-Upgrades und führt einen Wahrnehmungsclient aus, der Updates mit 30 fps sendet.
Parameter
- clientmode: "active" erzwingt den visuellen Nachverfolgungsmodus, wenn er nicht passiv eingerichtet werden kann
Holografische Wärme
Wenn Sie diese thermischen APIs verwenden, lesen Sie den Artikel Verwalten von Energie und Wärme .
/api/holographic/thermal/stage (GET)
Rufen Sie die Thermische Phase des Geräts ab (0 normal, 1 warm, 2 kritisch).
/api/holographic/thermal/getMitigationLevels (GET/websocket)
Öffnen Sie ein Websocket (oder führen Sie eine einzelne HTTP GET-Abfrage aus), und geben Sie eine Liste von Objekten zurück, die Folgendes enthält:
- IsSuppressed: Identifizieren, ob für ein bestimmtes Peripheriegerät Entschärfungen unterdrückt wurden
- Level : Neueste Wärmeschutzstufe für dieses Peripheriegerät
- Maske : Maske dieses Peripheriegeräts
- ThermalScore - Neueste Wärmebewertung für dieses Peripheriegerät
Objekte werden nach dem Namen des Peripheriegeräts benannt (Beispiel: Akku)
/api/holographic/thermal/setMitigationLevel (POST)
Ändern der gemeldeten Entschärfungsebene für ein bestimmtes Peripheriegerät
Parameter
- mask: Bitmaske mit Einzelbitsatz für das entsprechende Peripheriegerät (Weitere Informationen finden Sie unter PowerThermalPeripheralFlags ).
- Level: Neue zu verwendende Ebene (0-3)
/api/holographic/thermal/setThermalScore (POST)
Ändern der wärmetechnischen Bewertung, die für ein bestimmtes Peripheriegerät gemeldet wird
Parameter
- mask: Bitmaske mit Einzelbitsatz für das entsprechende Peripheriegerät (Weitere Informationen finden Sie unter PowerThermalPeripheralFlags ).
- thermalScore: Neue zu verwendende Wärmebewertung (100-0)
Zuordnungs-Manager
/api/holographic/mapmanager/mapFiles (GET)
Ruft die Liste der verfügbaren Kartendateien (MAPX) ab.
/api/holographic/mapmanager/anchorFiles (GET)
Ruft die Liste der verfügbaren Ankerdateien (.ancx) ab.
/api/holographic/mapmanager/srdbFiles (GET)
Ruft die Liste der verfügbaren Datenbankdateien für die räumliche Rekonstruktion (.srdb) ab.
/api/holographic/mapmanager/getanchors (GET)
Ruft die Liste der persistenten Anker für den aktuellen Benutzer ab.
Herunterladen/Hochladen/Löschen von Dateien
/api/holographic/mapmanager/download (GET)
Lädt eine Karten-, Anker- oder Räumliche Rekonstruktionsdatenbankdatei herunter. Die Datei muss zuvor hochgeladen oder exportiert worden sein.
Parameter
- FileName: Name der datei, die heruntergeladen werden soll.
Beispiel:
$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)
/api/holographic/mapmanager/upload (POST)
Lädt eine Karten-, Anker- oder Räumliche Rekonstruktionsdatenbankdatei hoch. Sobald eine Datei hochgeladen wurde, kann sie später importiert und vom System verwendet werden.
Parameter
- file: Name der datei, die hochgeladen werden soll.
Beispiel:
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)
Löscht eine Zuordnungs-, Anker- oder räumliche Rekonstruktionsdatenbankdatei. Die Datei muss zuvor hochgeladen oder exportiert worden sein.
Parameter
- FileName: Name der zu löschenden Datei.
Beispiel:
$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)
Exportieren
/api/holographic/mapmanager/export (POST)
Exportiert die karte, die derzeit vom System verwendet wird. Nach dem Export kann es heruntergeladen werden.
Beispiel:
$.post("/api/holographic/mapmanager/export")
/api/holographic/mapmanager/exportanchors (POST)
Exportiert die karte, die derzeit vom System verwendet wird. Nach dem Export kann es heruntergeladen werden. Beispiel:
$.post("/api/holographic/mapmanager/exportanchors")
/api/holographic/mapmanager/exportmapandanchors (POST)
Exportiert die Karte und die Anker, die derzeit vom System verwendet werden. Nach dem Export können sie heruntergeladen werden. Beispiel:
$.post("/api/holographic/mapmanager/exportmapandanchors")
/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)
Exportiert die karten- und räumliche Rekonstruktionsdatenbank, die derzeit vom System verwendet wird. Nach dem Export können sie heruntergeladen werden.
Beispiel:
$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")
Importieren
/api/holographic/mapmanager/import (POST)
Gibt dem System an, welche Zuordnung verwendet werden soll. Kann für Dateien aufgerufen werden, die exportiert oder hochgeladen wurden.
Parameter
- FileName: Name der zu verwendenden Zuordnung.
Beispiel:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
/api/holographic/mapmanager/importanchors (POST)
Gibt dem System an, welche Anker verwendet werden sollen. Kann für Dateien aufgerufen werden, die exportiert oder hochgeladen wurden.
Parameter
- FileName: Name der zu verwendenden Anker.
Beispiel:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
/api/holographic/mapmanager/importspatialmappingdb (POST)
Gibt dem System an, welche räumliche Rekonstruktionsdatenbank verwendet werden soll. Kann für Dateien aufgerufen werden, die exportiert oder hochgeladen wurden.
Parameter
- FileName: Name der zu verwendenden Datenbank für die räumliche Zuordnung.
Beispiel:
$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })
Sonstiges
/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)
Setzen Sie das System zurück, die Kartendatenbank, die Anker und die räumliche Rekonstruktionsdatenbank.
Beispiel:
$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")
/api/holographic/mapmanager/status (GET)
Ruft die status des Systems ab, einschließlich der letzten Importierten Karten-, Anker- und Räumlichen Rekonstruktionsdatenbankdateien.
Mixed Reality Capture
/api/holographic/mrc/file (GET)
Lädt eine Mixed Reality-Datei vom Gerät herunter. Verwenden Sie den Abfrageparameter op=stream für das Streaming.
Parameter
- filename: Name(hex64-codiert) der abzurufenden Videodatei
- op: stream
/api/holographic/mrc/file (DELETE)
Löscht eine Mixed Reality-Aufzeichnung vom Gerät.
Parameter
- filename: Name(hex64-codiert) der zu löschenden Datei
/api/holographic/mrc/files (GET)
Gibt die Liste der Mixed Reality-Dateien zurück, die auf dem Gerät gespeichert sind.
/api/holographic/mrc/photo (POST)
Nimmt ein Mixed Reality-Foto auf und erstellt eine Datei auf dem Gerät.
Parameter
- holo: Erfassen von Hologrammen: true oder false (Standardwert: false)
- pv: Aufnahme der PV-Kamera: true oder false (Standardwert: false)
- RenderFromCamera: (nur HoloLens 2) Rendern aus der Perspektive der Foto-/Videokamera: true oder false (Standardwert: true)
/api/holographic/mrc/settings (GET)
Ruft die Standardmäßigen Mixed Reality-Aufnahmeeinstellungen ab.
/api/holographic/mrc/settings (POST)
Legt die Standardeinstellungen für die Mixed Reality-Aufnahme fest. Einige dieser Einstellungen werden auf die MRC-Foto- und Videoaufnahme des Systems angewendet.
/api/holographic/mrc/status (GET)
Ruft den Status der Mixed Reality-Erfassung im Windows-Geräteportal ab.
Response
Die Antwort enthält eine JSON-Eigenschaft, die angibt, ob das Windows-Geräteportal Videos aufzeichnet oder nicht.
{"IsRecording": boolean}
/api/holographic/mrc/thumbnail (GET)
Ruft das Miniaturbild für die angegebene Datei ab.
Parameter
- filename: Name der Datei, für die die Miniaturansicht angefordert wird, hex64-codiert
/api/holographic/mrc/video/control/start (POST)
Startet eine Mixed Reality-Aufzeichnung.
Parameter
- holo: Erfassen von Hologrammen: true oder false (Standardwert: false)
- pv: Aufnahme der PV-Kamera: true oder false (Standardwert: false)
- mikrofon: Aufnahmemikrofon: true oder false (Standardwert: false)
- loopback: Erfassen von App-Audio: true oder false (Standardwert: false)
- RenderFromCamera: (nur HoloLens 2) Rendern aus der Perspektive der Foto-/Videokamera: true oder false (Standardwert: true)
- vstab: (nur HoloLens 2) Videostabilisierung aktivieren: true oder false (Standardwert: true)
- vstabbuffer: (nur HoloLens 2) Latenz des Videostabilisierungspuffers: 0 bis 30 Frames (standardwert: 15 Frames)
/api/holographic/mrc/video/control/stop (POST)
Beendet die aktuelle Mixed Reality-Aufzeichnung.
Mixed Reality Streaming
Achtung
Aufgrund der Loopbackisolation können Sie keine Verbindung mit Mixed Reality-Streaming aus einer App auf einem Gerät herstellen.
HoloLens unterstützt die Livevorschau von Mixed Reality über den blockierten Download eines fragmentierten mp4-Speichers.
Mixed Reality-Streams verwenden den gleichen Satz von Parametern, um zu steuern, was erfasst wird:
- holo: Erfassen von Hologrammen: true oder false
- pv: Aufnahme der PV-Kamera: true oder false
- mikrofon: Aufnahmemikrofon: true oder false
- Loopback: Erfassen von App-Audio: true oder false
Wenn keine dieser Angaben angegeben ist, werden Hologramme, Foto-/Videokameras und App-Audiodaten erfasst.
Wenn angegeben sind, werden die nicht angegebenen Parameter standardmäßig auf false festgelegt.
Optionale Parameter (nur HoloLens 2)
- RenderFromCamera: Rendern aus der Perspektive der Foto-/Videokamera: true oder false (Standardwert: true)
- vstab: Videostabilisierung aktivieren: true oder false (Standardwert: false)
- vstabbuffer: Latenz des Videostabilisierungspuffers: 0 bis 30 Frames (Standard: 15 Frames)
/api/holographic/stream/live.mp4 (GET)
Ein 1280x720p 30fps 5MBit-Stream.
/api/holographic/stream/live_high.mp4 (GET)
Ein 1280x720p 30fps 5MBit-Stream.
/api/holographic/stream/live_med.mp4 (GET)
Ein 854x480p 30fps 2,5Mbit-Stream.
/api/holographic/stream/live_low.mp4 (GET)
Ein 0,6-Bit-Stream mit 428 x 240p mit 15 fbits.
Netzwerk
/api/networking/ipconfig (GET)
Ruft die aktuelle IP-Konfiguration ab.
Betriebssysteminformationen
/api/os/info (GET)
Ruft Betriebssysteminformationen ab
/api/os/machinename (GET)
Ruft den Computernamen ab.
/api/os/machinename (POST)
Legt den Computernamen fest.
Parameter
- name: Neuer Computername, hex64-codiert, der auf festgelegt werden soll
Steuerung der Wahrnehmungssimulation
/api/holographic/simulation/control/mode (GET)
Ruft den Simulationsmodus ab.
/api/holographic/simulation/control/mode (POST)
Legt den Simulationsmodus fest.
Parameter
- Modus: Simulationsmodus: Standard, Simulation, Remote, Legacy
/api/holographic/simulation/control/stream (DELETE)
Löschen sie einen Steuerelementdatenstrom.
/api/holographic/simulation/control/stream (GET/WebSocket)
Öffnen Sie eine WebSocket-Verbindung für einen Steuerungsdatenstrom.
/api/holographic/simulation/control/stream (POST)
Erstellen Sie einen Steuerungsdatenstrom (Priorität ist erforderlich), oder stellen Sie Daten in einen erstellten Stream bereit (streamId erforderlich). Es wird erwartet, dass die bereitgestellten Daten vom Typ "application/octet-stream" sein.
/api/holographic/simulation/display/stream (GET/WebSocket)
Fordern Sie einen Simulationsvideodatenstrom an, der den Inhalt enthält, der im Modus "Simulation" auf der Systemanzeige gerendert wird. Zunächst wird ein einfacher Formatdeskriptorheader gesendet, gefolgt von H.264-codierten Texturen, denen jeweils ein Header vorangestellt ist, der den Augenindex und die Texturgröße angibt.
Wiedergabe der Wahrnehmungssimulation
/api/holographic/simulation/playback/file (DELETE)
Löschen sie eine Aufzeichnung.
Parameter
- recording: Name der zu löschenden Aufzeichnung.
/api/holographic/simulation/playback/file (POST)
Laden Sie eine Aufzeichnung hoch.
/api/holographic/simulation/playback/files (GET)
Ruft alle Aufzeichnungen ab.
/api/holographic/simulation/playback/session (GET)
Ruft den aktuellen Wiedergabezustand einer Aufzeichnung ab.
Parameter
- recording: Name der Aufzeichnung.
/api/holographic/simulation/playback/session/file (DELETE)
Entladen Sie eine Aufzeichnung.
Parameter
- Recording: Name der zu entladenden Aufzeichnung.
/api/holographic/simulation/playback/session/file (POST)
Laden sie eine Aufzeichnung.
Parameter
- recording: Name der zu ladenden Aufzeichnung.
/api/holographic/simulation/playback/session/files (GET)
Ruft alle geladenen Aufzeichnungen ab.
/api/holographic/simulation/playback/session/pause (POST)
Anhalten einer Aufzeichnung.
Parameter
- recording: Name der Aufzeichnung.
/api/holographic/simulation/playback/session/play (POST)
Wiedergeben einer Aufzeichnung.
Parameter
- recording: Name der Aufzeichnung.
/api/holographic/simulation/playback/session/stop (POST)
Beenden sie eine Aufzeichnung.
Parameter
- recording: Name der Aufzeichnung.
/api/holographic/simulation/playback/session/types (GET)
Ruft die Datentypen in einer geladenen Aufzeichnung ab.
Parameter
- recording: Name der Aufzeichnung.
Aufzeichnung der Wahrnehmungssimulation
/api/holographic/simulation/recording/start (POST)
Starten Sie eine Aufzeichnung. Nur eine einzelne Aufzeichnung kann gleichzeitig aktiv sein. Eines davon muss festgelegt sein: Kopf, Hände, spatialMapping oder Umgebung.
Parameter
- head: Legen Sie auf 1 fest, um Kopfdaten aufzuzeichnen.
- hands: Legen Sie auf 1 fest, um Handdaten aufzuzeichnen.
- spatialMapping: Legen Sie auf 1 fest, um die räumliche Zuordnung aufzuzeichnen.
- Environment: Legen Sie auf 1 fest, um Umgebungsdaten aufzuzeichnen.
- name: Name der Aufzeichnung.
- singleSpatialMappingFrame: Legen Sie auf 1 fest, um nur einen einzelnen räumlichen Zuordnungsrahmen aufzuzeichnen.
/api/holographic/simulation/recording/status (GET)
Ruft den Aufzeichnungszustand ab.
/api/holographic/simulation/recording/stop (GET)
Beenden Sie die aktuelle Aufzeichnung. Die Aufzeichnung wird als Datei zurückgegeben.
Leistungsdaten
/api/resourcemanager/processes (GET)
Gibt die Liste der ausgeführten Prozesse mit Details zurück.
Daten zurückgeben
- JSON mit einer Liste der Prozesse und Details für jeden Prozess
/api/resourcemanager/systemperf (GET)
Gibt System-Perf-Statistiken zurück (E/A-Lese-/Schreibzugriff, Arbeitsspeicherstatistiken usw.).
Daten zurückgeben
- JSON mit Systeminformationen: CPU, GPU, Arbeitsspeicher, Netzwerk, E/A
Leistung
/api/power/battery (GET)
Ruft den aktuellen Akkuzustand ab.
/api/power/state (GET)
Überprüft, ob sich das System in einem Energiesparmodus befindet.
Remotesteuerung
/api/control/restart (POST)
Startet das Zielgerät neu.
/api/control/shutdown (POST)
Fährt das Zielgerät herunter.
Task-Manager
/api/taskmanager/app (DELETE)
Beendet eine moderne App.
Parameter
- package: Vollständiger Name des App-Pakets, hex64-codiert
- forcestop: Erzwingen des Beendens aller Prozesse (=ja)
/api/taskmanager/app (POST)
Startet eine moderne App.
Parameter
- appid: PRAID der zu startenden App, hex64-codiert
- package: Vollständiger Name des App-Pakets, hex64-codiert
WLAN-Verwaltung
/api/wifi/interfaces (GET)
Listet Drahtlose Netzwerkschnittstellen auf.
Daten zurückgeben
- Liste der Drahtlosen Schnittstellen mit Details (GUID, Beschreibung usw.)
/api/wifi/network (DELETE)
Löscht ein Profil, das einem Netzwerk auf einer angegebenen Schnittstelle zugeordnet ist.
Parameter
- Interface: Guid der Netzwerkschnittstelle
- profil: Profilname
/api/wifi/networks (GET)
Listet Drahtlosnetzwerke auf der angegebenen Netzwerkschnittstelle auf.
Parameter
- Interface: Guid der Netzwerkschnittstelle
Daten zurückgeben
- Liste der drahtlosen Netzwerke auf der Netzwerkschnittstelle mit Details
/api/wifi/network (POST)
Stellt eine Verbindung mit einem Netzwerk auf der angegebenen Schnittstelle her oder trennt es.
Parameter
- Interface: Guid der Netzwerkschnittstelle
- ssid: ssid, hex64 codiert, um eine Verbindung mit herzustellen
- op: Verbinden oder Trennen
- createprofile: ja oder nein
- Schlüssel: Gemeinsam genutzter Schlüssel, hex64-codiert
Windows Performance Recorder
/api/wpr/customtrace (POST)
Lädt ein WPR-Profil hoch und beginnt mit der Ablaufverfolgung mithilfe des hochgeladenen Profils.
Nutzlast
- mehrteiliger http-Konformer Text
Daten zurückgeben
- Gibt den WPR-Sitzungsstatus zurück.
/api/wpr/status (GET)
Ruft die status der WPR-Sitzung ab.
Daten zurückgeben
- WPR-Sitzungs-status.
/api/wpr/trace (GET)
Beendet eine WPR-Ablaufverfolgungssitzung (Performance).
Daten zurückgeben
- Gibt die ETL-Datei der Ablaufverfolgung zurück.
/api/wpr/trace (POST)
Startet eine WPR-Ablaufverfolgungssitzung (Performance).
Parameter
- profile: Profilname. Verfügbare Profile werden in perfprofiles/profiles.json gespeichert.
Daten zurückgeben
- Gibt beim Start die WPR-Sitzung status zurück.