Informations de référence sur les API du portail d’appareil

Article
07/12/2023

Tout ce qui se trouve dans le portail d’appareil Windows s’appuie sur les API REST que vous pouvez utiliser pour accéder aux données et contrôler votre appareil par programmation.

Déploiement des applications

/api/app/packagemanager/package (DELETE)

Désinstalle une application.

Paramètres

package : nom de fichier du package à désinstaller.

/api/app/packagemanager/package (POST)

Installe une application.

Paramètres

package : nom de fichier du package à installer.

Payload

corps http conforme à plusieurs parties

/api/app/packagemanager/packages (GET)

Récupère la liste des applications installées sur le système. Inclut des détails.

Retourner les données

Liste des packages installés avec des détails

/api/app/packagemanager/state (GET)

Obtient le status de l’installation de l’application en cours.

Collection de vidages

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

Désactive la collecte de vidage sur incident pour une application chargée de manière indépendante.

Paramètres

packageFullName : nom du package

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

Obtient les paramètres de la collecte de vidage sur incident des applications chargées de manière indépendante.

Paramètres

packageFullName : nom du package

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

Active et définit les paramètres de contrôle de vidage pour une application chargée de manière indépendante.

Paramètres

packageFullName : nom du package

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

Supprime un vidage sur incident pour une application chargée de manière indépendante.

Paramètres

packageFullName : nom du package
fileName : nom du fichier de vidage

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

Récupère un vidage sur incident pour une application chargée de manière indépendante.

Paramètres

packageFullName : nom du package
fileName : nom du fichier de vidage

Retourner les données

Fichier de vidage. Inspectez avec WinDbg ou Visual Studio.

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

Retourne la liste de tous les vidages sur incident pour les applications chargées de manière indépendante.

Retourner les données

Liste des vidages sur incident par application chargée côté

ETW

/api/etw/providers (GET)

Énumère les fournisseurs inscrits.

Retourner les données

Liste des fournisseurs, nom convivial et GUID

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

Crée une session ETW en temps réel ; géré sur un websocket.

Retourner les données

Événements ETW des fournisseurs activés

Système d’exploitation holographique

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

Renvoie une liste de fournisseurs ETW spécifiques à HoloLens qui ne sont pas inscrits auprès du système.

/api/holographic/os/services (GET)

Retourne les états de tous les services en cours d’exécution.

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

Obtient l’IPD stocké (distance interpupillary) en millimètres.

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

Définit l’IPD.

Paramètres

ipd : nouvelle valeur IPD à définir en millimètres

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

Obtient les exigences HTTPS pour le portail d’appareil.

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

Définit les exigences HTTPS pour le portail d’appareil.

Paramètres

obligatoire : oui, non ou par défaut

Perception holographique

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

Accepte les mises à niveau WebSocket et exécute un client de perception qui envoie les mises à jour à 30 fps.

Paramètres

clientmode : « actif » force le mode de suivi visuel lorsqu’il ne peut pas être établi passivement

Thermique holographique

Lorsque vous utilisez ces API thermiques, reportez-vous à l’article Gestion de l’alimentation et des éléments thermiques .

/api/holographic/thermal/stage (GET)

Obtenez l’étape thermique de l’appareil (0 normal, 1 chaud, 2 critique).

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

Ouvrez un websocket (ou effectuez une requête HTTP GET unique), renvoyant une liste d’objets contenant les éléments suivants :

IsSuppressed : identification de la suppression des atténuations d’un périphérique donné
Level : dernier niveau d’atténuation thermique pour ce périphérique
Masque : masque de ce périphérique
ThermalScore - Dernier score thermique pour ce périphérique

Les objets sont nommés par nom de périphérique (exemple : Batterie)

/api/holographic/thermal/setMitigationLevel (POST)

Modifier le niveau d’atténuation signalé pour un périphérique donné

Paramètres

mask: bitmask with single bit set for the périphérique of interest (voir PowerThermalPeripheralFlags pour plus d’informations )
niveau : nouveau niveau à utiliser (0-3)

/api/holographic/thermal/setThermalScore (POST)

Modifier le score thermique signalé pour un périphérique donné

Paramètres

mask : masque de bits avec un bit défini pour le périphérique d’intérêt (voir PowerThermalPeripheralFlags pour plus d’informations)
thermalScore : nouveau score thermique à utiliser (100-0)

Map Manager

/api/holographic/mapmanager/mapFiles (GET)

Obtient la liste des fichiers cartographiques disponibles (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Obtient la liste des fichiers d’ancre disponibles (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Obtient la liste des fichiers de base de données de reconstruction spatiale disponibles (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Obtient la liste des ancres persistantes pour l’utilisateur actuel.

Télécharger/charger/supprimer des fichiers

/api/holographic/mapmanager/download (GET)

Télécharge un fichier de base de données cartographique, d’ancre ou de reconstruction spatiale. Le fichier doit avoir été précédemment chargé ou exporté.

Paramètres

FileName : nom du fichier à télécharger.

Exemple :

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

/api/holographic/mapmanager/upload (POST)

Charge un fichier de base de données cartographique, d’ancre ou de reconstruction spatiale. Une fois qu’un fichier est chargé, il peut être importé et utilisé par le système.

Paramètres

file : nom du fichier à charger.

Exemple :

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)

Supprime un fichier de base de données cartographique, d’ancre ou de reconstruction spatiale. Le fichier doit avoir été précédemment chargé ou exporté.

Paramètres

FileName : nom du fichier à supprimer.

Exemple :

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

Exporter

/api/holographic/mapmanager/export (POST)

Exporte la carte actuellement utilisée par le système. Une fois exporté, il peut être téléchargé.

Exemple :

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

/api/holographic/mapmanager/exportanchors (POST)

Exporte la carte actuellement utilisée par le système. Une fois exporté, il peut être téléchargé. Exemple :

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Exporte la carte et les ancres actuellement utilisées par le système. Une fois exportés, ils peuvent être téléchargés. Exemple :

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Exporte la base de données cartographique et de reconstruction spatiale actuellement utilisée par le système. Une fois exportés, ils peuvent être téléchargés.

Exemple :

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

Importer

/api/holographic/mapmanager/import (POST)

Indique au système quel mappage doit être utilisé. Peut être appelé sur les fichiers qui ont été exportés ou chargés.

Paramètres

FileName : nom de la carte à utiliser.

Exemple :

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

/api/holographic/mapmanager/importanchors (POST)

Indique au système quelles ancres doivent être utilisées. Peut être appelé sur les fichiers qui ont été exportés ou chargés.

Paramètres

FileName : nom des ancres à utiliser.

Exemple :

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Indique au système quelle base de données de reconstruction spatiale doit être utilisée. Peut être appelé sur les fichiers qui ont été exportés ou chargés.

Paramètres

FileName : nom de la base de données de mappage spatial à utiliser.

Exemple :

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

Autres

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Réinitialisez le système la carte, les ancres et la base de données de reconstruction spatiale.

Exemple :

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

/api/holographic/mapmanager/status (GET)

Obtient la status du système, y compris les fichiers de carte, d’ancres et de base de données de reconstruction spatiale qui ont été importés pour la dernière fois.

MRC (Mixed Reality Capture)

/api/holographic/mrc/file (GET)

Télécharge un fichier de réalité mixte à partir de l’appareil. Utilisez le paramètre de requête op=stream pour la diffusion en continu.

Paramètres

nom_fichier : nom, encodé en hex64, du fichier vidéo à obtenir
op: stream

/api/holographic/mrc/file (DELETE)

Supprime un enregistrement de réalité mixte de l’appareil.

Paramètres

nom_fichier : nom, encodé en hex64, du fichier à supprimer

/api/holographic/mrc/files (GET)

Retourne la liste des fichiers de réalité mixte stockés sur l’appareil.

/api/holographic/mrc/photo (POST)

Prend une photo de réalité mixte et crée un fichier sur l’appareil.

Paramètres

holo : capture d’hologrammes : true ou false (valeur par défaut false)
pv : capture de la caméra PV : true ou false (la valeur par défaut est false)
RenderFromCamera : (HoloLens 2 uniquement) rendu du point de vue de l’appareil photo/vidéo : true ou false (valeur par défaut true)

/api/holographic/mrc/settings (GET)

Obtient les paramètres de capture de réalité mixte par défaut.

/api/holographic/mrc/settings (POST)

Définit les paramètres de capture de réalité mixte par défaut. Certains de ces paramètres sont appliqués à la capture de photos et de vidéos CRM du système.

/api/holographic/mrc/status (GET)

Obtient l’état de la capture de réalité mixte dans le portail d’appareil Windows.

Response

La réponse contient une propriété JSON qui indique si le portail d’appareil Windows enregistre la vidéo ou non.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Obtient l’image miniature du fichier spécifié.

Paramètres

filename : nom, encodé en hex64, du fichier pour lequel la miniature est demandée

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

Démarre un enregistrement de réalité mixte.

Paramètres

holo : capture d’hologrammes : true ou false (valeur par défaut false)
pv : capture de la caméra PV : true ou false (la valeur par défaut est false)
micro : microphone de capture : true ou false (la valeur par défaut est false)
bouclage : capturer l’audio de l’application : true ou false (la valeur par défaut est false)
RenderFromCamera : (HoloLens 2 uniquement) rendu du point de vue de l’appareil photo/vidéo : true ou false (valeur par défaut true)
vstab : (HoloLens 2 uniquement) activer la stabilisation vidéo : true ou false (la valeur par défaut est true)
vstabbuffer : (HoloLens 2 uniquement) latence de la mémoire tampon de stabilisation vidéo : 0 à 30 images (15 images par défaut)

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

Arrête l’enregistrement de réalité mixte actuel.

streaming Mixed Reality

Attention

En raison de l’isolation de bouclage, vous ne pouvez pas vous connecter à la diffusion en continu de réalité mixte à partir d’une application sur un appareil.

HoloLens prend en charge l’aperçu en direct de la réalité mixte via le téléchargement en bloc d’un mp4 fragmenté.

Les flux de réalité mixte partagent le même ensemble de paramètres pour contrôler ce qui est capturé :

holo : capture d’hologrammes : true ou false
pv : capture de la caméra PV : true ou false
micro : microphone de capture : true ou false
bouclage : capturer l’audio de l’application : true ou false

Si aucun de ces éléments n’est spécifié, les hologrammes, l’appareil photo/vidéo et l’audio de l’application sont capturés.

Si des paramètres sont spécifiés, la valeur par défaut des paramètres non spécifiés est false

Paramètres facultatifs (HoloLens 2 uniquement)

RenderFromCamera : rendu du point de vue de l’appareil photo/vidéo : true ou false (la valeur par défaut est true)
vstab : activer la stabilisation vidéo : true ou false (la valeur par défaut est false)
vstabbuffer : latence de la mémoire tampon de stabilisation vidéo : 0 à 30 images (15 images par défaut)

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

Un flux 1280 x 720 p 30fps 5 Mbit.

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

Un flux 1280 x 720 p 30fps 5 Mbit.

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

Un flux 854 x 480p 30fps 2,5 Mbit.

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

Flux 428 x 240p 15fps 0,6 Mbit.

Mise en réseau

/api/networking/ipconfig (GET)

Obtient la configuration IP actuelle.

Informations sur le système d’exploitation

/api/os/info (GET)

Obtient des informations sur le système d’exploitation.

/api/os/machinename (GET)

Obtient le nom de la machine.

/api/os/machinename (POST)

Définit le nom de la machine.

Paramètres

name : nouveau nom de machine, encodé en hex64, à définir sur

Contrôle de simulation de perception

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

Obtient le mode de simulation.

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

Définit le mode de simulation.

Paramètres

mode : mode de simulation : par défaut, simulation, à distance, hérité

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

Supprimer un flux de contrôle.

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

Ouvrez une connexion WebSocket pour un flux de contrôle.

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

Créez un flux de contrôle (la priorité est requise) ou publiez des données dans un flux créé (streamId requis). Les données publiées doivent être de type « application/octet-stream ».

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

Demandez un flux vidéo de simulation contenant le contenu affiché sur l’affichage système en mode « Simulation ». Un en-tête de descripteur de format simple est initialement envoyé, suivi de textures encodées en H.264, chacune précédée d’un en-tête indiquant l’index oculaire et la taille de la texture.

Lecture de simulation de perception

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

Supprimer un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement à supprimer.

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

Charger un enregistrement.

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

Obtenez tous les enregistrements.

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

Obtenir l’état de lecture actuel d’un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement.

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

Déchargez un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement à décharger.

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

Charger un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement à charger.

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

Obtenir tous les enregistrements chargés.

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

Suspendre un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement.

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

Lire un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement.

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

Arrêter un enregistrement.

Paramètres

enregistrement : nom de l’enregistrement.

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

Obtenez les types de données dans un enregistrement chargé.

Paramètres

enregistrement : nom de l’enregistrement.

Enregistrement de simulation de perception

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

Démarrez un enregistrement. Un seul enregistrement peut être actif à la fois. L’une d’elles doit être définie : tête, mains, spatialMapping ou environnement.

Paramètres

head : définissez sur 1 pour enregistrer les données de tête.
mains : définissez sur 1 pour enregistrer les données de la main.
spatialMapping : définissez sur 1 pour enregistrer le mappage spatial.
environnement : définissez sur 1 pour enregistrer les données d’environnement.
name : nom de l’enregistrement.
singleSpatialMappingFrame : définissez sur 1 pour enregistrer une seule trame de mappage spatial.

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

Obtenir l’état de l’enregistrement.

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

Arrêtez l’enregistrement en cours. L’enregistrement sera retourné sous forme de fichier.

Données relatives aux performances

/api/resourcemanager/processes (GET)

Retourne la liste des processus en cours d’exécution avec des détails.

Retourner les données

JSON avec la liste des processus et les détails de chaque processus

/api/resourcemanager/systemperf (GET)

Retourne des statistiques de performances système (lecture/écriture d’E/S, statistiques de mémoire, etc.

Retourner les données

JSON avec des informations système : PROCESSEUR, GPU, mémoire, réseau, E/S

Power

/api/power/battery (GET)

Obtient l’état actuel de la batterie.

/api/power/state (GET)

Vérifie si le système est dans un état de faible consommation d’énergie.

Contrôle à distance

/api/control/restart (POST)

Redémarre l’appareil cible.

/api/control/shutdown (POST)

Arrête l’appareil cible.

Gestionnaire des tâches

/api/taskmanager/app (DELETE)

Arrête une application moderne.

Paramètres

package : nom complet du package d’application, codé hex64
forcestop : forcer l’arrêt de tous les processus (=oui)

/api/taskmanager/app (POST)

Démarre une application moderne

Paramètres

appid : PRAID de l’application à démarrer, codé hex64
package : nom complet du package d’application, codé hex64

Gestion wi-fi

/api/wifi/interfaces (GET)

Énumère les interfaces réseau sans fil.

Retourner les données

Liste des interfaces sans fil avec des détails (GUID, description, etc.)

/api/wifi/network (DELETE)

Supprime un profil associé à un réseau sur une interface spécifiée.

Paramètres

interface : GUID d’interface réseau
profil : nom du profil

/api/wifi/networks (GET)

Énumère les réseaux sans fil sur l’interface réseau spécifiée.

Paramètres

interface : GUID d’interface réseau

Retourner les données

Liste des réseaux sans fil trouvés sur l’interface réseau avec les détails

/api/wifi/network (POST)

Se connecte ou se déconnecte d’un réseau sur l’interface spécifiée.

Paramètres

interface : GUID d’interface réseau
ssid : ssid, encodé hex64, à connecter à
op : se connecter ou se déconnecter
createprofile : oui ou non
clé : clé partagée, codée hex64

Enregistreur de performances Windows

/api/wpr/customtrace (POST)

Charge un profil WPR et commence le suivi à l’aide du profil chargé.

Payload

corps http conforme à plusieurs parties

Retourner les données

Retourne le status de session WPR.

/api/wpr/status (GET)

Récupère le status de la session WPR

Retourner les données

status de session WPR.

/api/wpr/trace (GET)

Arrête une session de suivi WPR (performances).

Retourner les données

Retourne le fichier ETL de trace

/api/wpr/trace (POST)

Démarre une session de suivi WPR (performances).

Paramètres

profile : nom du profil. Les profils disponibles sont stockés dans perfprofiles/profiles.json

Retourner les données

Au démarrage, retourne la session WPR status.

Informations de référence sur les API du portail d’appareil

Déploiement des applications

Collection de vidages

ETW

Système d’exploitation holographique

Perception holographique

Thermique holographique

Map Manager

Télécharger/charger/supprimer des fichiers

Exporter

Importer

Autres

MRC (Mixed Reality Capture)

streaming Mixed Reality

Mise en réseau

Informations sur le système d’exploitation

Contrôle de simulation de perception

Lecture de simulation de perception

Enregistrement de simulation de perception

Données relatives aux performances

Power

Contrôle à distance

Gestionnaire des tâches

Gestion wi-fi

Enregistreur de performances Windows

Voir aussi

Ressources supplémentaires