Informazioni di riferimento sulle API di Portale di dispositivi

  • Articolo

Tutto ciò che si trova in Windows Device Portal si basa sull'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 a più parti

/api/app/packagemanager/packages (GET)

Recupera l'elenco delle 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 trasferita localmente.

Parametri

  • packageFullName: nome del pacchetto

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

Ottiene le impostazioni per la raccolta di dump di arresto anomalo del sistema delle app trasferite localmente.

Parametri

  • packageFullName: nome del pacchetto

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

Abilita e imposta le impostazioni del controllo dump per un'app trasferita localmente.

Parametri

  • packageFullName: nome del pacchetto

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

Elimina un dump di arresto anomalo per un'app trasferita localmente.

Parametri

  • packageFullName: nome del pacchetto
  • fileName: nome file dump

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

Recupera un dump di arresto anomalo per un'app trasferita localmente.

Parametri

  • packageFullName: nome del 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 trasferite localmente.

Restituisce i dati

  • Elenco di dump di arresto anomalo del sistema per app trasferita localmente

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 su un websocket.

Restituisce i dati

  • Eventi ETW dai provider abilitati

Sistema operativo olografico

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

Restituisce un elenco di provider ETW specifici di HoloLens non 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 Device Portal.

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

Imposta i requisiti HTTPS per Device Portal.

Parametri

  • obbligatorio: sì, no o impostazione predefinita

Percezione olografica

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

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

Parametri

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

Olografico Termico

Quando si usano queste API termiche, fare riferimento all'articolo sulla gestione della potenza 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), restituendo un elenco di oggetti contenenti quanto segue:

  • IsSuppressed - Identificazione se una determinata periferica ha mitigazioni eliminate
  • 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 set a bit singolo per la periferica di interesse (per informazioni dettagliate, vedere PowerTermalPeripheralFlags )
  • livello: nuovo livello da usare (0-3)

/api/holographic/thermal/setTermalScore (POST)

Modificare il punteggio termico segnalato per una determinata periferica

Parametri

  • mask: maschera di bit con set a bit singolo per la periferica di interesse (per informazioni dettagliate, vedere PowerTermalPeripheralFlags )
  • thermalScore: 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 di ricostruzione spaziale disponibili (con estensione srdb).

/api/holographic/mapmanager/getanchors (GET)

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

Download/Caricamento/Eliminazione di file

/api/holographic/mapmanager/download (GET)

Scarica un file di database di mapping, ancoraggio o ricostruzione 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 una mappa, un ancoraggio o un file di database di ricostruzione spaziale. Dopo il caricamento di 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 di mapping, ancoraggio o ricostruzione 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. Dopo l'esportazione, è possibile scaricarla.

Esempio:

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

/api/holographic/mapmanager/exportanchors (POST)

Esporta la mappa attualmente in uso dal sistema. Dopo l'esportazione, è possibile scaricarla. Esempio:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Esporta la mappa e gli ancoraggi attualmente in uso dal sistema. Dopo l'esportazione, è possibile scaricarli. Esempio:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Esporta il database di ricostruzione mappa e spaziale attualmente in uso dal sistema. Dopo l'esportazione, è possibile scaricarli.

Esempio:

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

Importa

/api/holographic/mapmanager/import (POST)

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

Parametri

  • FileName: nome della mappa da utilizzare.

Esempio:

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

/api/holographic/mapmanager/importanchors (POST)

Indica al sistema da usare gli ancoraggi. Può essere chiamato sui 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 ricostruzione spaziale da utilizzare. Può essere chiamato sui 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 sistema sulla mappa, sugli ancoraggi e sul database di ricostruzione spaziale.

Esempio:

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

/api/holographic/mapmanager/status (GET)

Ottiene lo stato del sistema, tra cui quali mapping, ancoraggi e file di database di ricostruzione spaziale sono stati importati per 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, 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, 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)

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

Parametri

  • ologramma: acquisizione di ologrammi: true o false (impostazione predefinita su false)
  • pv: acquisizione della fotocamera PV: true o false (impostazione predefinita su false)
  • RenderFromCamera: (solo HoloLens 2) viene eseguito il rendering dal punto di vista della fotocamera/fotocamera: true o false (il valore predefinito è true)

/api/holographic/mrc/settings (GET)

Ottiene le impostazioni predefinite di acquisizione della realtà mista.

/api/holographic/mrc/settings (POST)

Imposta le impostazioni predefinite di acquisizione della 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 portale di dispositivi Windows.

Risposta

La risposta contiene una proprietà JSON che indica se Windows Device Portal sta registrando video o meno.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Ottiene l'immagine di anteprima per il file specificato.

Parametri

  • nome: nome, hex64 codificato, del file per il quale viene richiesta l'anteprima

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

Avvia una registrazione di realtà mista.

Parametri

  • holo: acquisire ologrammi: true o false (impostazione predefinita su false)
  • pv: acquisire la fotocamera PV: true o false (impostazione predefinita su false)
  • microfono: acquisizione del microfono: true o false (impostazione predefinita su false)
  • loopback: acquisire l'audio dell'app: true o false (impostazione predefinita su false)
  • RenderFromCamera: (solo HoloLens 2) rendering dal punto di vista della fotocamera foto/video: true o false (impostazione predefinita su true)
  • vstab: (solo HoloLens 2) abilitare la stabilizzazione video: true o false (impostazione predefinita su true)
  • vstabbuffer: (solo HoloLens 2) la latenza del buffer di stabilizzazione video: da 0 a 30 fotogrammi (impostazione predefinita a 15 fotogrammi)

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

Arresta la registrazione della realtà mista corrente.

streaming Realtà mista

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:

  • holo: acquisire ologrammi: true o false
  • pv: acquisizione della fotocamera PV: true o false
  • microfono: acquisizione del microfono: true o false
  • loopback: acquisire l'audio dell'app: true o false

Se nessuno di questi elementi viene specificato, verranno acquisiti ologrammi, foto/fotocamera video e audio dell'app.

Se sono specificati, i parametri non specificati verranno predefiniti su false

Parametri facoltativi (solo HoloLens 2)

  • RenderFromCamera: rendering dal punto di vista della fotocamera foto/video: true o false (impostazione predefinita su true)
  • vstab: abilitare la stabilizzazione video: true o false (impostazione predefinita su false)
  • vstabbuffer: latenza del buffer di stabilizzazione video: da 0 a 30 fotogrammi (impostazione predefinita a 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, da impostare su

Controllo simulazione della 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: impostazione 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à è necessaria) o pubblicare i dati in un flusso creato (streamId obbligatorio). I dati pubblicati devono essere 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". Un'intestazione di descrittore di formato semplice verrà inviata inizialmente, seguita da trame con codifica H.264, con ognuna preceduta da un'intestazione che indica l'indice oculare e le dimensioni della trama.

Riproduzione simulazione percezione

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

Eliminare una registrazione.

Parametri

  • registrazione: nome della registrazione da eliminare.

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

Caricare una registrazione.

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

Ottenere tutte le registrazioni.

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

Ottenere lo stato di riproduzione corrente di una registrazione.

Parametri

  • registrazione: nome della registrazione.

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

Scarica una registrazione.

Parametri

  • registrazione: nome della registrazione da scaricare.

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

Caricare una registrazione.

Parametri

  • registrazione: 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

  • registrazione: 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. Una sola registrazione può essere attiva contemporaneamente. Una di queste deve essere impostata: testa, mani, spatialMapping o ambiente.

Parametri

  • head: impostare su 1 per registrare i dati head.
  • mani: 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: impostato 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 sulle prestazioni di sistema (lettura/scrittura 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)

Controlla se il sistema si trova in uno 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: forzare l'arresto di tutti i processi (=sì)

/api/taskmanager/app (POST)

Avvia un'app moderna

Parametri

  • appid: PRAID dell'app da avviare, con codifica 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 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 delle reti wireless disponibili nell'interfaccia di rete con i dettagli

/api/wifi/network (POST)

Connette o si disconnette a una rete nell'interfaccia specificata.

Parametri

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

Registratore delle prestazioni di Windows

/api/wpr/customtrace (POST)

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

Payload

  • corpo HTTP conforme a 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 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