Referencia de la API del Portal de dispositivos

  • Artículo

Todo lo que se encuentra en el Portal de dispositivos Windows se basa en la API rest que puede usar para acceder a los datos y controlar el dispositivo mediante programación.

Implementación de la aplicación

/api/app/packagemanager/package (DELETE)

Desinstala una aplicación.

Parámetros

  • package: nombre de archivo del paquete que se va a desinstalar.

/api/app/packagemanager/package (POST)

Instala una aplicación.

Parámetros

  • package: nombre de archivo del paquete que se va a instalar.

Carga

  • cuerpo http conforme a varias partes

/api/app/packagemanager/packages (GET)

Recupera la lista de aplicaciones instaladas en el sistema. Incluye detalles.

Devolver datos

  • Lista de paquetes instalados con detalles

/api/app/packagemanager/state (GET)

Obtiene el estado de la instalación de la aplicación en curso.

Colección de volcados de memoria

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

Deshabilita la recopilación de volcados de memoria para una aplicación transferida localmente.

Parámetros

  • packageFullName: nombre del paquete

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

Obtiene la configuración de la recopilación de volcados de memoria de las aplicaciones transferidas localmente.

Parámetros

  • packageFullName: nombre del paquete

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

Habilita y establece la configuración del control de volcado de memoria para una aplicación transferida localmente.

Parámetros

  • packageFullName: nombre del paquete

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

Elimina un volcado de memoria para una aplicación transferida localmente.

Parámetros

  • packageFullName: nombre del paquete
  • fileName: nombre del archivo de volcado

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

Recupera un volcado de memoria para una aplicación transferida localmente.

Parámetros

  • packageFullName: nombre del paquete
  • fileName: nombre del archivo de volcado

Devolver datos

  • Archivo de volcado de memoria. Inspeccione con WinDbg o Visual Studio.

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

Devuelve la lista de todos los volcados de memoria de las aplicaciones transferidas localmente.

Devolver datos

  • Lista de volcados de memoria por aplicación cargada por lado

ETW

/api/etw/providers (GET)

Enumera los proveedores registrados.

Devolver datos

  • Lista de proveedores, nombre descriptivo y GUID

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

Crea una sesión ETW en tiempo real; administrado a través de un websocket.

Devolver datos

  • Eventos ETW de los proveedores habilitados

SO Holographic

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

Devuelve una lista de proveedores ETW específicos de HoloLens que no están registrados en el sistema.

/api/holographic/os/services (GET)

Devuelve los estados de todos los servicios que se ejecutan.

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

Obtiene el IPD almacenado (distancia interpupilar) en milímetros.

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

Establece el IPD.

Parámetros

  • ipd: nuevo valor de IPD que se va a establecer en milímetros

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

Obtiene los requisitos HTTPS para Device Portal.

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

Establece los requisitos https para Device Portal.

Parámetros

  • obligatorio: sí, no o predeterminado

Percepción holográfica

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

Acepta actualizaciones de WebSocket y ejecuta un cliente de percepción que envía actualizaciones a 30 fps.

Parámetros

  • clientmode: "active" fuerza el modo de seguimiento visual cuando no se puede establecer pasivamente

Termal holográfica

Al usar estas API térmicas, consulte el artículo sobre administración de energía y termal .

/api/holographic/thermal/stage (GET)

Obtenga la fase térmica del dispositivo (0 normal, 1 cálido, 2 crítico).

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

Abra un websocket (o realice una sola consulta HTTP GET) y devuelva una lista de objetos que contengan lo siguiente:

  • IsSuppressed: identificación de si un periférico determinado tiene mitigaciones suprimidas
  • Nivel: nivel de mitigación térmica más reciente para este periférico
  • Máscara: máscara de este periférico
  • ThermalScore: puntuación térmica más reciente para este periférico

Los objetos se denominan por nombre periférico (ejemplo: Batería)

/api/holographic/thermal/setMitigationLevel (POST)

Cambiar el nivel de mitigación que se notifica para un periférico determinado

Parámetros

  • mask: máscara de bits con un solo bit establecido para el periférico de interés (consulte PowerThermalPeripheralFlags para obtener más información)
  • level: nuevo nivel que se va a usar (0-3)

/api/holographic/thermal/setThermalScore (POST)

Cambiar la puntuación térmica que se notifica para un periférico determinado

Parámetros

  • mask: máscara de bits con un solo bit establecido para el periférico de interés (consulte PowerThermalPeripheralFlags para obtener más información)
  • thermalScore: nueva puntuación térmica que se usará (100-0)

Map Manager (Administrador de mapas)

/api/holographic/mapmanager/mapFiles (GET)

Obtiene la lista de los archivos de mapa disponibles (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Obtiene la lista de archivos de delimitadores disponibles (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Obtiene la lista de archivos de base de datos de reconstrucción espacial disponibles (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Obtiene la lista de delimitadores persistentes para el usuario actual.

Descargar, cargar o eliminar archivos

/api/holographic/mapmanager/download (GET)

Descarga un archivo de base de datos de asignación, delimitador o de reconstrucción espacial. El archivo debe haberse cargado o exportado previamente.

Parámetros

  • FileName: nombre del archivo que se va a descargar.

Ejemplo:

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

/api/holographic/mapmanager/upload (POST)

Carga un archivo de base de datos de asignación, delimitador o de reconstrucción espacial. Una vez cargado un archivo, el sistema puede importarlo y usarlo más adelante.

Parámetros

  • file: nombre del archivo que se va a cargar.

Ejemplo:

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 archivo de base de datos de asignación, delimitador o de reconstrucción espacial. El archivo debe haberse cargado o exportado previamente.

Parámetros

  • FileName: nombre del archivo que se va a eliminar.

Ejemplo:

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

Exportación

/api/holographic/mapmanager/export (POST)

Exporta el mapa actualmente en uso por el sistema. Una vez exportado, se puede descargar.

Ejemplo:

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

/api/holographic/mapmanager/exportanchors (POST)

Exporta el mapa actualmente en uso por el sistema. Una vez exportado, se puede descargar. Ejemplo:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Exporta el mapa y los anclajes actualmente en uso por el sistema. Una vez exportados, se pueden descargar. Ejemplo:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Exporta la base de datos de asignación y reconstrucción espacial actualmente en uso por el sistema. Una vez exportados, se pueden descargar.

Ejemplo:

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

Importación

/api/holographic/mapmanager/import (POST)

Indica al sistema el que se debe usar el mapa. Se puede llamar a en archivos que se han exportado o cargado.

Parámetros

  • FileName: nombre del mapa que se va a usar.

Ejemplo:

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

/api/holographic/mapmanager/importanchors (POST)

Indica al sistema qué delimitadores se deben usar. Se puede llamar a en archivos que se han exportado o cargado.

Parámetros

  • FileName: nombre de los delimitadores que se van a usar.

Ejemplo:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Indica al sistema qué base de datos de reconstrucción espacial se debe usar. Se puede llamar a en archivos que se han exportado o cargado.

Parámetros

  • FileName: nombre de la base de datos de asignación espacial que se va a usar.

Ejemplo:

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

Otros

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Restablezca el sistema el mapa, los delimitadores y la base de datos de reconstrucción espacial.

Ejemplo:

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

/api/holographic/mapmanager/status (GET)

Obtiene el estado del sistema, incluido el mapa, los delimitadores y los archivos de base de datos de reconstrucción espacial que se importaron por última vez.

Captura de realidad mixta

/api/holographic/mrc/file (GET)

Descarga un archivo de realidad mixta del dispositivo. Use el parámetro de consulta op=stream para el streaming.

Parámetros

  • filename: nombre, hex64 codificado, del archivo de vídeo que se va a obtener.
  • op: stream

/api/holographic/mrc/file (DELETE)

Elimina una grabación de realidad mixta del dispositivo.

Parámetros

  • filename: nombre, hex64 codificado, del archivo que se va a eliminar.

/api/holographic/mrc/files (GET)

Devuelve la lista de archivos de realidad mixta almacenados en el dispositivo.

/api/holographic/mrc/photo (POST)

Toma una foto de realidad mixta y crea un archivo en el dispositivo.

Parámetros

  • holo: capturar hologramas: true o false (el valor predeterminado es false)
  • pv: cámara pv de captura: true o false (el valor predeterminado es false)
  • RenderFromCamera: (solo HoloLens 2) representar desde la perspectiva de la cámara de fotos/vídeo: true o false (el valor predeterminado es true)

/api/holographic/mrc/settings (GET)

Obtiene la configuración predeterminada de captura de realidad mixta.

/api/holographic/mrc/settings (POST)

Establece la configuración predeterminada de captura de realidad mixta. Algunos de estos ajustes se aplican a la captura de fotos y vídeos mrC del sistema.

/api/holographic/mrc/status (GET)

Obtiene el estado de captura de realidad mixta en el Portal de dispositivos Windows.

Respuesta

La respuesta contiene una propiedad JSON que indica si El Portal de dispositivos Windows está grabando vídeo o no.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Obtiene la imagen en miniatura del archivo especificado.

Parámetros

  • filename: nombre, codificado hexadecimal64, del archivo para el que se solicita la miniatura.

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

Inicia una grabación de realidad mixta.

Parámetros

  • holo: capturar hologramas: true o false (el valor predeterminado es false)
  • pv: cámara PV de captura: true o false (el valor predeterminado es false)
  • mic: capturar micrófono: true o false (el valor predeterminado es false)
  • loopback: capture el audio de la aplicación: true o false (el valor predeterminado es false)
  • RenderFromCamera: (solo HoloLens 2) representar desde la perspectiva de la cámara de fotos y vídeos: true o false (el valor predeterminado es true)
  • vstab: (solo HoloLens 2) habilitar la estabilización de vídeo: true o false (el valor predeterminado es true)
  • vstabbuffer: (solo HoloLens 2) latencia del búfer de estabilización de vídeo: de 0 a 30 fotogramas (el valor predeterminado es de 15 fotogramas)

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

Detiene la grabación de realidad mixta actual.

streaming de Mixed Reality

Precaución

Debido al aislamiento de bucle invertido, no se puede conectar al streaming de realidad mixta desde dentro de una aplicación en un dispositivo.

HoloLens admite la versión preliminar en vivo de la realidad mixta a través de la descarga fragmentada de un mp4 fragmentado.

Las secuencias de realidad mixta comparten el mismo conjunto de parámetros para controlar lo que se captura:

  • holo: capturar hologramas: true o false
  • pv: capturar cámara PV: true o false
  • mic: capturar micrófono: true o false
  • loopback: capture el audio de la aplicación: true o false

Si no se especifica ninguna de estas opciones, se capturarán hologramas, cámara de fotos y vídeos y audio de la aplicación.

Si se especifica alguno, los parámetros no especificados tendrán como valor predeterminado false.

Parámetros opcionales (solo HoloLens 2)

  • RenderFromCamera: representación desde la perspectiva de la cámara de fotos o vídeos: true o false (el valor predeterminado es true)
  • vstab: habilitar la estabilización de vídeo: true o false (el valor predeterminado es false)
  • vstabbuffer: latencia del búfer de estabilización de vídeo: de 0 a 30 fotogramas (el valor predeterminado es de 15 fotogramas)

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

Flujo de 1280x720p 30fps de 5Mbits.

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

Flujo de 1280x720p 30fps de 5Mbits.

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

Flujo de 854x480p 30fps 2,5Mbits.

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

Flujo de 428 x 240p de 15 fps de 0,6 Mbit.

Redes

/api/networking/ipconfig (GET)

Obtiene la configuración de IP actual.

Información del sistema operativo

/api/os/info (GET)

Obtiene información del sistema operativo.

/api/os/machinename (GET)

Obtiene el nombre de la máquina.

/api/os/machinename (POST)

Establece el nombre de la máquina.

Parámetros

  • name: nuevo nombre de máquina, codificado hexadecimal64, para establecer en

Control de simulación de percepción

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

Obtiene el modo de simulación.

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

Establece el modo de simulación.

Parámetros

  • mode: modo de simulación: predeterminado, simulación, remoto, heredado

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

Elimine un flujo de control.

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

Abra una conexión de WebSocket para una secuencia de control.

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

Cree un flujo de control (se requiere prioridad) o publique datos en una secuencia creada (se requiere streamId). Se espera que los datos publicados sean de tipo "application/octet-stream".

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

Solicite una secuencia de vídeo de simulación que contenga el contenido representado en la pantalla del sistema cuando esté en modo "Simulación". Inicialmente, se enviará un encabezado descriptor de formato simple, seguido de texturas codificadas con H.264, con cada uno precedido por un encabezado que indica el índice del ojo y el tamaño de textura.

Reproducción de simulación de percepción

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

Eliminar una grabación.

Parámetros

  • recording: nombre de la grabación que se va a eliminar.

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

Cargue una grabación.

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

Obtenga todas las grabaciones.

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

Obtiene el estado de reproducción actual de una grabación.

Parámetros

  • recording: nombre de la grabación.

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

Descargue una grabación.

Parámetros

  • recording: nombre de la grabación que se va a descargar.

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

Cargue una grabación.

Parámetros

  • recording: nombre de la grabación que se va a cargar.

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

Obtenga todas las grabaciones cargadas.

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

Pausar una grabación.

Parámetros

  • recording: nombre de la grabación.

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

Reproducir una grabación.

Parámetros

  • recording: nombre de la grabación.

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

Detenga una grabación.

Parámetros

  • recording: nombre de la grabación.

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

Obtenga los tipos de datos en una grabación cargada.

Parámetros

  • recording: nombre de la grabación.

Grabación de simulación de percepción

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

Inicie una grabación. Solo una sola grabación puede estar activa a la vez. Uno de estos debe establecerse: head, hands, spatialMapping o environment.

Parámetros

  • head: establézcalo en 1 para registrar los datos principales.
  • manos: establezca en 1 para registrar los datos de mano.
  • spatialMapping: establezca en 1 para registrar la asignación espacial.
  • environment: establezca en 1 para registrar los datos del entorno.
  • name: nombre de la grabación.
  • singleSpatialMappingFrame: establezca en 1 para registrar solo un marco de asignación espacial único.

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

Obtiene el estado de grabación.

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

Detenga la grabación actual. La grabación se devolverá como un archivo.

Datos de rendimiento

/api/resourcemanager/processes (GET)

Devuelve la lista de procesos en ejecución con detalles.

Devolver datos

  • JSON con una lista de procesos y detalles para cada proceso

/api/resourcemanager/systemperf (GET)

Devuelve estadísticas de rendimiento del sistema (lectura y escritura de E/S, estadísticas de memoria, etc.

Devolver datos

  • JSON con información del sistema: CPU, GPU, memoria, red, E/S

Power

/api/power/battery (GET)

Obtiene el estado actual de la batería.

/api/power/state (GET)

Comprueba si el sistema está en un estado de bajo consumo.

Control remoto

/api/control/restart (POST)

Reinicia el dispositivo de destino.

/api/control/shutdown (POST)

Apaga el dispositivo de destino.

Administrador de tareas

/api/taskmanager/app (DELETE)

Detiene una aplicación moderna.

Parámetros

  • package: nombre completo del paquete de la aplicación, codificado hexadecimal64
  • forcetop: forzar que todos los procesos se detengan (=sí)

/api/taskmanager/app (POST)

Inicia una aplicación moderna

Parámetros

  • appid: PRAID de la aplicación que se va a iniciar, codificado hexadecimal64
  • package: nombre completo del paquete de la aplicación, codificado hexadecimal64

Administración de WiFi

/api/wifi/interfaces (GET)

Enumera las interfaces de red inalámbrica.

Devolver datos

  • Lista de interfaces inalámbricas con detalles (GUID, descripción, etc.)

/api/wifi/network (DELETE)

Elimina un perfil asociado a una red en una interfaz especificada.

Parámetros

  • interfaz: guid de interfaz de red
  • profile: nombre del perfil

/api/wifi/networks (GET)

Enumera las redes inalámbricas en la interfaz de red especificada.

Parámetros

  • interfaz: guid de interfaz de red

Devolver datos

  • Lista de redes inalámbricas que se encuentran en la interfaz de red con detalles

/api/wifi/network (POST)

Conecta o desconecta a una red en la interfaz especificada.

Parámetros

  • interfaz: guid de interfaz de red
  • ssid: ssid, hex64 codificado, para conectarse a
  • op: conectar o desconectar
  • createprofile: sí o no
  • key: clave compartida, codificada hexadecimal64

Grabadora de rendimiento de Windows

/api/wpr/customtrace (POST)

Carga un perfil de WPR e inicia el seguimiento mediante el perfil cargado.

Carga

  • cuerpo http conforme a varias partes

Devolver datos

  • Devuelve el estado de sesión WPR.

/api/wpr/status (GET)

Recupera el estado de la sesión de WPR.

Devolver datos

  • Estado de la sesión de WPR.

/api/wpr/trace (GET)

Detiene una sesión de seguimiento de WPR (rendimiento).

Devolver datos

  • Devuelve el archivo ETL de seguimiento.

/api/wpr/trace (POST)

Inicia una sesión de seguimiento de WPR (rendimiento).

Parámetros

  • profile: nombre del perfil. Los perfiles disponibles se almacenan en perfprofiles/profiles.json

Devolver datos

  • Al iniciar, devuelve el estado de sesión de WPR.

Consulte también