Informazioni di riferimento sulle API di Portale di dispositivi

Tutti gli elementi Windows Portale di dispositivi si basano sulle API REST che è possibile usare per accedere ai dati e controllare il dispositivo a livello di codice.

Distribuzione di app

/api/app/packagemanager/package (DELETE)

Disinstalla un'app.

Parametri

  • package: nome file del pacchetto da disinstallare.

/api/app/packagemanager/package (POST)

Installa un'app.

Parametri

  • package: nome file del pacchetto da installare.

Payload

  • corpo HTTP conforme in più parti

/api/app/packagemanager/packages (GET)

Recupera l'elenco di app installate nel sistema. Include i dettagli.

Restituisce i dati

  • Elenco dei pacchetti installati con i dettagli

/api/app/packagemanager/state (GET)

Ottiene lo stato dell'installazione dell'app in corso.

Raccolta dei dump

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

Disabilita la raccolta di dump di arresto anomalo del sistema per un'app con sideloaded.

Parametri

  • packageFullname: nome pacchetto

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

Ottiene le impostazioni per la raccolta di dump di arresto anomalo delle app affiancate.

Parametri

  • packageFullname: nome pacchetto

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

Abilita e imposta le impostazioni del controllo dump per un'app con sideloaded.

Parametri

  • packageFullname: nome pacchetto

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

Elimina un dump di arresto anomalo del sistema per un'app sideloaded.

Parametri

  • packageFullname: nome pacchetto
  • fileName: nome file dump

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

Recupera un dump di arresto anomalo del sistema per un'app sideloaded.

Parametri

  • packageFullname: nome pacchetto
  • fileName: nome file dump

Restituisce i dati

  • File di dump. Esaminare con WinDbg o Visual Studio.

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

Restituisce l'elenco di tutti i dump di arresto anomalo del sistema per le app con sideloaded.

Restituisce i dati

  • Elenco di dump di arresto anomalo del sistema per ogni app con caricamento laterale

ETW

/api/etw/providers (GET)

Enumera i provider registrati.

Restituisce i dati

  • Elenco di provider, nome descrittivo e GUID

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

Crea una sessione ETW in tempo reale. gestito tramite un websocket.

Restituisce i dati

  • Eventi ETW dai provider abilitati

Sistema operativo olografico

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

Restituisce un elenco HoloLens provider ETW specifici che non sono registrati nel sistema.

/api/holographic/os/services (GET)

Restituisce gli stati di tutti i servizi in esecuzione.

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

Ottiene l'IPD archiviato (distanza interpupillare) in millimetri.

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

Imposta l'IPD.

Parametri

  • ipd: nuovo valore IPD da impostare in millimetri

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

Ottiene i requisiti HTTPS per l'Portale di dispositivi.

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

Imposta i requisiti HTTPS per il Portale di dispositivi.

Parametri

  • obbligatorio: sì, no o predefinito

Percezione olografica

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

Accetta gli aggiornamenti di WebSocket ed esegue un client perception che invia gli aggiornamenti a 30 fps.

Parametri

  • clientmode: "active" forza la modalità di rilevamento visivo quando non può essere stabilita passivamente

Termica olografica

Quando si usano queste API termiche, fare riferimento all'articolo gestione dell'alimentazione e delle termiche .

/api/holographic/thermal/stage (GET)

Ottenere la fase termica del dispositivo (0 normale, 1 caldo, 2 critico).

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

Aprire un websocket (o eseguire una singola query HTTP GET), restituisce un elenco di oggetti contenenti gli elementi seguenti:

  • IsSuppressed: identificazione se una determinata periferica ha eliminato le mitigazioni
  • Livello - Livello di mitigazione termica più recente per questa periferica
  • Maschera - Maschera di questa periferica
  • ThermalScore - Punteggio termico più recente per questa periferica

Gli oggetti sono denominati in base al nome della periferica (esempio: Batteria)

/api/holographic/thermal/setMitigationLevel (POST)

Modificare il livello di mitigazione segnalato per una determinata periferica

Parametri

  • mask: maschera di bit con bit singolo impostato per la periferica di interesse (per informazioni dettagliate, vedere PowerThermalPeripheralFlags )
  • level: nuovo livello da usare (0-3)

/api/olographic/termoreal/setThermalScore (POST)

Modificare il punteggio termico segnalato per una determinata periferica

Parametri

  • mask: maschera di bit con bit singolo impostato per la periferica di interesse (vedere PowerThermalPeripheralFlags per informazioni dettagliate)
  • termorescore: nuovo punteggio termico da usare (100-0)

Map Manager (Gestore mappe)

/api/holographic/mapmanager/mapFiles (GET)

Ottiene l'elenco dei file di mappa disponibili (con estensione mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Ottiene l'elenco dei file di ancoraggio disponibili (con estensione ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Ottiene l'elenco dei file di database spaziali di ripristino disponibili (con estensione srdb).

/api/holographic/mapmanager/getanchors (GET)

Ottiene l'elenco di ancoraggi persistenti per l'utente corrente.

Scaricare/Upload/eliminare file

/api/holographic/mapmanager/download (GET)

Scarica un file di database mappa, ancoraggio o spaziale. Il file deve essere stato caricato o esportato in precedenza.

Parametri

  • FileName: nome del file da scaricare.

Esempio:

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

/api/holographic/mapmanager/upload (POST)

Carica un file di database mappa, ancoraggio o spaziale. Una volta caricato, un file può essere importato e usato dal sistema in un secondo momento.

Parametri

  • file: nome del file da caricare.

Esempio:

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)

Elimina un file di database mappa, ancoraggio o spaziale. Il file deve essere stato caricato o esportato in precedenza.

Parametri

  • FileName: nome del file da eliminare.

Esempio:

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

Esportazione

/api/holographic/mapmanager/export (POST)

Esporta la mappa attualmente in uso dal sistema. Una volta esportato, può essere scaricato.

Esempio:

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

/api/holographic/mapmanager/exportanchors (POST)

Esporta la mappa attualmente in uso dal sistema. Una volta esportato, può essere scaricato. Esempio:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Esporta la mappa e gli ancoraggi attualmente in uso dal sistema. Una volta esportati, possono essere scaricati. Esempio:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Esporta il database di mappa e di ricorsiva spaziale attualmente in uso dal sistema. Una volta esportati, possono essere scaricati.

Esempio:

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

Importa

/api/holographic/mapmanager/import (POST)

Indica al sistema la mappa da usare. Può essere chiamato su file che sono stati esportati o caricati.

Parametri

  • FileName: nome della mappa da usare.

Esempio:

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

/api/holographic/mapmanager/importanchors (POST)

Indica al sistema gli ancoraggi da usare. Può essere chiamato su file che sono stati esportati o caricati.

Parametri

  • FileName: nome degli ancoraggi da usare.

Esempio:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Indica al sistema il database di ricorsiva spaziale da usare. Può essere chiamato su file che sono stati esportati o caricati.

Parametri

  • FileName: nome del database di mapping spaziale da usare.

Esempio:

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

Altro

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Reimpostare il database della mappa, degli ancoraggi e dello spazio del sistema.

Esempio:

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

/api/holographic/mapmanager/status (GET)

Ottiene lo stato del sistema, incluse le mappe, gli ancoraggi e i file di database spaziali di cui è stata importata l'ultima volta.

Mixed Reality Capture

/api/holographic/mrc/file (GET)

Scarica un file di realtà mista dal dispositivo. Usare il parametro di query op=stream per lo streaming.

Parametri

  • filename: nome, con codifica hex64, del file video da ottenere
  • op: stream

/api/holographic/mrc/file (DELETE)

Elimina una registrazione di realtà mista dal dispositivo.

Parametri

  • filename: nome, con codifica hex64, del file da eliminare

/api/holographic/mrc/files (GET)

Restituisce l'elenco dei file di realtà mista archiviati nel dispositivo.

/api/holographic/mrc/photo (POST)

Crea una foto di realtà mista e crea un file nel dispositivo.

Parametri

  • holo: capture ologrammi: true o false (il valore predefinito è false)
  • pv: capture PV camera: true o false (il valore predefinito è false)
  • RenderFromCamera: rendering (HoloLens 2) dal punto di vista della fotocamera/videocamera: true o false (il valore predefinito è true)

/api/holographic/mrc/settings (GET)

Ottiene le impostazioni predefinite di acquisizione di realtà mista.

/api/holographic/mrc/settings (POST)

Imposta le impostazioni predefinite di acquisizione di realtà mista. Alcune di queste impostazioni vengono applicate all'acquisizione di foto e video MRC del sistema.

/api/holographic/mrc/status (GET)

Ottiene lo stato dell'acquisizione di realtà mista all'interno del Windows Portale di dispositivi.

Risposta

La risposta contiene una proprietà JSON che indica se Windows Portale di dispositivi video o meno.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Ottiene l'immagine di anteprima per il file specificato.

Parametri

  • filename: nome, con codifica hex64, del file per cui viene richiesta l'anteprima

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

Avvia una registrazione di realtà mista.

Parametri

  • holo: capture holograms: true o false (il valore predefinito è false)
  • pv: capture PV camera: true o false (il valore predefinito è false)
  • mic: capture microphone: true o false (il valore predefinito è false)
  • loopback: acquisisci l'audio dell'app: true o false (il valore predefinito è false)
  • RenderFromCamera: (solo HoloLens 2) rendering dal punto di vista della foto/videocamera: true o false (il valore predefinito è true)
  • vstab: (solo HoloLens 2) abilita la stabilizzazione video: true o false (il valore predefinito è true)
  • vstabbuffer: (solo HoloLens 2) latenza del buffer di stabilizzazione video: da 0 a 30 fotogrammi (il valore predefinito è 15 fotogrammi)

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

Arresta la registrazione di realtà mista corrente.

Realtà mista streaming

Attenzione

A causa dell'isolamento del loopback, non è possibile connettersi allo streaming di realtà mista dall'interno di un'app in un dispositivo.

HoloLens supporta l'anteprima live della realtà mista tramite il download in blocchi di un mp4 frammentato.

I flussi di realtà mista condividono lo stesso set di parametri per controllare ciò che viene acquisito:

  • olo: acquisizione di ologrammi: true o false
  • pv: acquisizione della fotocamera PV: true o false
  • microfono: acquisisci microfono: true o false
  • loopback: acquisizione dell'audio dell'app: true o false

Se non ne viene specificato nessuno, verranno acquisiti ologrammi, foto/videocamere e audio dell'app.

Se vengono specificati parametri non specificati, il valore predefinito sarà false

Parametri facoltativi (HoloLens 2 facoltativi)

  • RenderFromCamera: rendering dal punto di vista della foto/videocamera: true o false (il valore predefinito è true)
  • vstab: abilita la stabilizzazione video: true o false (il valore predefinito è false)
  • vstabbuffer: latenza del buffer di stabilizzazione video: da 0 a 30 fotogrammi (il valore predefinito è 15 fotogrammi)

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

Flusso 1280x720p 30fps 5Mbit.

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

Flusso 1280x720p 30fps 5Mbit.

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

Flusso 854x480p 30fps 2.5Mbit.

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

Flusso 428x240p 15fps 0,6Mbit.

Rete

/api/networking/ipconfig (GET)

Ottiene la configurazione IP corrente.

Informazioni sul sistema operativo

/api/os/info (GET)

Ottiene le informazioni sul sistema operativo.

/api/os/machinename (GET)

Ottiene il nome del computer.

/api/os/machinename (POST)

Imposta il nome del computer.

Parametri

  • name: nuovo nome del computer con codifica hex64, su cui impostare

Controllo simulazione percezione

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

Ottiene la modalità di simulazione.

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

Imposta la modalità di simulazione.

Parametri

  • modalità: modalità di simulazione: predefinita, simulazione, remota, legacy

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

Eliminare un flusso di controllo.

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

Aprire una connessione WebSocket per un flusso di controllo.

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

Creare un flusso di controllo (la priorità è obbligatoria) o pubblicare i dati in un flusso creato (streamId obbligatorio). È previsto che i dati inseriti siano di tipo 'application/octet-stream'.

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

Richiedere un flusso video di simulazione contenente il contenuto sottoposto a rendering nella visualizzazione del sistema in modalità "Simulazione". Inizialmente verrà inviata un'intestazione del descrittore di formato semplice, seguita da trame con codifica H.264, ognuna preceduta da un'intestazione che indica l'indice degli occhi e le dimensioni della trama.

Riproduzione simulazione percezione

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

Eliminare una registrazione.

Parametri

  • recording: nome della registrazione da eliminare.

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

Upload una registrazione.

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

Ottenere tutte le registrazioni.

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

Ottiene lo stato di riproduzione corrente di una registrazione.

Parametri

  • recording: nome della registrazione.

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

Scaricare una registrazione.

Parametri

  • recording: nome della registrazione da scaricare.

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

Caricare una registrazione.

Parametri

  • recording: nome della registrazione da caricare.

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

Ottenere tutte le registrazioni caricate.

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

Sospendere una registrazione.

Parametri

  • recording: nome della registrazione.

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

Riprodurre una registrazione.

Parametri

  • recording: nome della registrazione.

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

Arrestare una registrazione.

Parametri

  • recording: nome della registrazione.

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

Ottenere i tipi di dati in una registrazione caricata.

Parametri

  • recording: nome della registrazione.

Registrazione simulazione percezione

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

Avviare una registrazione. Solo una singola registrazione può essere attiva contemporaneamente. Uno di questi deve essere impostato: head, hands, spatialMapping o environment.

Parametri

  • head: impostare su 1 per registrare i dati head.
  • hands: impostare su 1 per registrare i dati della mano.
  • spatialMapping: impostare su 1 per registrare il mapping spaziale.
  • environment: impostare su 1 per registrare i dati dell'ambiente.
  • name: nome della registrazione.
  • singleSpatialMappingFrame: impostata su 1 per registrare solo un singolo frame di mapping spaziale.

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

Ottiene lo stato di registrazione.

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

Arrestare la registrazione corrente. La registrazione verrà restituita come file.

Dati sulle prestazioni

/api/resourcemanager/processes (GET)

Restituisce l'elenco dei processi in esecuzione con i dettagli.

Restituisce i dati

  • JSON con elenco di processi e dettagli per ogni processo

/api/resourcemanager/systemperf (GET)

Restituisce statistiche di prestazioni di sistema (lettura/scrittura di I/O, statistiche di memoria e così via.

Restituisce i dati

  • JSON con informazioni di sistema: CPU, GPU, memoria, rete, I/O

Elettricità

/api/power/battery (GET)

Ottiene lo stato corrente della batteria.

/api/power/state (GET)

Verifica se il sistema è in stato di alimentazione insufficiente.

Controllo remoto

/api/control/restart (POST)

Riavvia il dispositivo di destinazione.

/api/control/shutdown (POST)

Arresta il dispositivo di destinazione.

Gestione attività

/api/taskmanager/app (DELETE)

Arresta un'app moderna.

Parametri

  • package: nome completo del pacchetto dell'app con codifica hex64
  • forcestop: forza l'arresto di tutti i processi (=sì)

/api/taskmanager/app (POST)

Avvia un'app moderna

Parametri

  • appid: PRAID dell'app da avviare, codificato hex64
  • package: nome completo del pacchetto dell'app con codifica hex64

Gestione Wi-Fi

/api/wifi/interfaces (GET)

Enumera le interfacce di rete wireless.

Restituisce i dati

  • Elenco di interfacce wireless con dettagli (GUID, descrizione e così via)

/api/wifi/network (DELETE)

Elimina un profilo associato a una rete in un'interfaccia specificata.

Parametri

  • interface: guid dell'interfaccia di rete
  • profile: nome del profilo

/api/wifi/networks (GET)

Enumera le reti wireless nell'interfaccia di rete specificata.

Parametri

  • interface: guid dell'interfaccia di rete

Restituisce i dati

  • Elenco di reti wireless trovate nell'interfaccia di rete con i dettagli

/api/wifi/network (POST)

Si connette o si disconnette a una rete nell'interfaccia specificata.

Parametri

  • interface: guid dell'interfaccia di rete
  • ssid: ssid, con codifica hex64, a cui connettersi
  • op: connettersi o disconnettersi
  • createprofile: sì o no
  • chiave: chiave condivisa, codificata hex64

Windows performance recorder

/api/wpr/customtrace (POST)

Carica un profilo WPR e avvia la traccia usando il profilo caricato.

Payload

  • corpo HTTP conforme in più parti

Restituisce i dati

  • Restituisce lo stato della sessione WPR.

/api/wpr/status (GET)

Recupera lo stato della sessione WPR

Restituisce i dati

  • Stato della sessione WPR.

/api/wpr/trace (GET)

Arresta una sessione di traccia WPR (prestazioni).

Restituisce i dati

  • Restituisce il file ETL di traccia

/api/wpr/trace (POST)

Avvia una sessione di traccia WPR (prestazioni).

Parametri

  • profile: nome del profilo. I profili disponibili vengono archiviati in perfprofiles/profiles.json

Restituisce i dati

  • All'avvio, restituisce lo stato della sessione WPR.

Vedi anche