Referência API do portal do dispositivo

Tudo no portal Windows dispositivo é construído em cima do REST API's que pode usar para aceder aos dados e controlar o seu dispositivo programáticamente.

Implementação de aplicações

/api/app/packagemanager/package (DELETE)

Desinstala uma aplicação.

Parâmetros

  • pacote: Nome do ficheiro da embalagem a desinstalar.

/api/app/packagemanager/packagemanager (POST)

Instala uma App.

Parâmetros

  • pacote: Nome do ficheiro da embalagem a instalar.

Carga útil

  • corpo http em conformidade multi-parte

/api/app/packagemanager/packagemanager /packages (GET)

Recupera a lista de aplicações instaladas no sistema. Inclui detalhes.

Dados de devolução

  • Lista de pacotes instalados com detalhes

/api/app/packagemanager/state (GET)

Obtém o estado da instalação de aplicações em curso.

Coleção de despejo

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

Desativa a recolha de despejos para uma aplicação sideloaded.

Parâmetros

  • pacoteFullname: nome do pacote

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

Obtém configurações para apps sideloaded crash dump collection.

Parâmetros

  • pacoteFullname: nome do pacote

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

Ativa e define as definições de controlo de despejo para uma aplicação carregada lateralmente.

Parâmetros

  • pacoteFullname: nome do pacote

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

Elimina uma lixeira para uma aplicação carregada lateralmente.

Parâmetros

  • pacoteFullname: nome do pacote
  • nome de arquivo: nome do ficheiro de despejo

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

Recupera uma lixeira para uma aplicação carregada lateralmente.

Parâmetros

  • pacoteFullname: nome do pacote
  • nome de arquivo: nome do ficheiro de despejo

Dados de devolução

  • Arquivo de despejo. Inspecione com winDbg ou Visual Studio.

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

Lista de devoluções de todos os depósitos de falhas para aplicações sideloaded.

Dados de devolução

  • Lista de despejos de colisão por aplicação carregada de lado

ETW

/api/etw/providers (GET)

Enumera os fornecedores registados.

Dados de devolução

  • Lista de fornecedores, nome amigável e GUID

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

Cria uma sessão ETW em tempo real; gerido sobre um websocket.

Dados de devolução

  • Eventos ETW dos fornecedores habilitados

Os soográficos

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

Devolve uma lista de fornecedores etw específicos HoloLens que não estão registados no sistema.

/api/holográfico/os/serviços (GET)

Devolve os estados de todos os serviços em execução.

/api/holográfico/os/definições/ipd (GET)

Obtém o IPD armazenado (distância interpupilar) em milímetros.

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

Define o IPD.

Parâmetros

  • ipd: Novo valor IPD a definir em milímetros

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

Obtém requisitos HTTPS para o Portal do Dispositivo.

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

Define os requisitos HTTPS para o Portal do Dispositivo.

Parâmetros

  • requerido: sim, não ou padrão

Perceção Holográfica

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

Aceita atualizações webSocket e executa um cliente de perceção que envia atualizações a 30 fps.

Parâmetros

  • clientmode: "ativo" força o modo de rastreio visual quando não pode ser estabelecido passivamente

Termais holográficos

/api/holográfico/térmico/estágio (GET)

Obtenha a fase térmica do dispositivo (0 normal, 1 quente, 2 crítico).

Gestor de mapas

/api/holographic/mapmanager/mapfiles (GET)

Obtém a lista dos ficheiros de mapas disponíveis (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Obtém a lista de ficheiros de âncora disponíveis (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Obtém a lista de ficheiros disponíveis de base de dados de reconstrução espacial (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Obtém a lista de âncoras persistiu para o utilizador atual.

Baixar/Carregar/Eliminar Ficheiros

/api/holographic/mapmanager/download (GET)

Descarrega um mapa, âncora ou ficheiro de base de dados de reconstrução espacial. O ficheiro deve ter sido previamente carregado ou exportado.

Parâmetros

  • Nome de arquivo: Nome do ficheiro para descarregar.

Exemplo:

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

/api/holographic/mapmanager/upload (POST)

Envia um mapa, âncora ou ficheiro de base de dados de reconstrução espacial. Uma vez que um ficheiro é carregado, pode ser mais tarde importado e usado pelo sistema.

Parâmetros

  • ficheiro: Nome do ficheiro para carregar.

Exemplo:

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 um mapa, âncora ou ficheiro de base de dados de reconstrução espacial. O ficheiro deve ter sido previamente carregado ou exportado.

Parâmetros

  • Nome de arquivo: Nome do ficheiro para eliminar.

Exemplo:

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

Exportar

/api/holographic/mapmanager/export (POST)

Exporta o mapa atualmente em uso pelo sistema. Uma vez exportado, pode ser descarregado.

Exemplo:

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

/api/holographic/mapmanager/exportanchors (POST)

Exporta o mapa atualmente em uso pelo sistema. Uma vez exportado, pode ser descarregado. Exemplo:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Exporta o mapa e âncoras atualmente em uso pelo sistema. Uma vez exportados, podem ser descarregados. Exemplo:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Exporta o mapa e a base de dados de reconstrução espacial atualmente em uso pelo sistema. Uma vez exportados, podem ser descarregados.

Exemplo:

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

Importar

/api/holographic/mapmanager/import (POST)

Indica ao sistema qual o mapa que deve ser utilizado. Pode ser chamado em ficheiros que tenham sido exportados ou carregados.

Parâmetros

  • Nome de arquivo: Nome do mapa a utilizar.

Exemplo:

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

/api/holographic/mapmanager/importanchors (POST)

Indica o sistema que as âncoras devem ser utilizadas. Pode ser chamado em ficheiros que tenham sido exportados ou carregados.

Parâmetros

  • Nome de arquivo: Nome das âncoras a utilizar.

Exemplo:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Indica ao sistema qual base de dados de reconstrução espacial deve ser utilizada. Pode ser chamado em ficheiros que tenham sido exportados ou carregados.

Parâmetros

  • Nome de arquivo: Nome do mapeamento espacial db a utilizar.

Exemplo:

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

Outro

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Reinicie o sistema do mapa, âncoras e base de dados de reconstrução espacial.

Exemplo:

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

/api/holographic/mapmanager/status (GET)

Obtém o estado do sistema, incluindo quais mapas, âncoras e ficheiros de base de dados de reconstrução espacial foram importados pela última vez.

Captura de realidade mista

/api/holographic/mrc/file (GET)

Descarrega um ficheiro de realidade mista do dispositivo. Utilize o parâmetro de consulta op=stream para o streaming.

Parâmetros

  • nome de arquivo: Nome, hex64 codificado, do ficheiro de vídeo para obter
  • op: stream

/api/holográfico/mrc/file (DELETE)

Elimina uma gravação de realidade mista do dispositivo.

Parâmetros

  • nome de arquivo: Nome, hex64 codificado, do ficheiro para eliminar

/api/holographic/mrc/files (GET)

Devolve a lista de ficheiros de realidade mista armazenados no dispositivo.

/api/holographic/mrc/photo (POST)

Pega numa foto de realidade mista e cria um ficheiro no dispositivo.

Parâmetros

  • holo: capturar hologramas: verdadeiros ou falsos (incumprimentos a falsos)
  • pv: capturar câmara PV: verdadeira ou falsa (incumprimentos a falsos)
  • RenderFromCamera: (apenas HoloLens 2) renderizam do ponto de vista da câmara fotográfica/vídeo: verdadeiro ou falso (incumprimentos para verdade)

/api/holographic/mrc/settings (GET)

Obtém as definições padrão de captura de realidade mista.

/api/holographic/mrc/settings (POST)

Define as definições de captura de realidade mista padrão. Algumas destas definições são aplicadas à captura de fotografias e vídeos MRC do sistema.

/api/holographic/mrc/status (GET)

Obtém o estado da captura da realidade mista dentro do Portal do Dispositivo Windows.

Resposta

A resposta contém uma propriedade JSON que indica se Windows Portal do Dispositivo está a gravar vídeo ou não.

{"IsRecording": boolean}

/api/holographic/mrc/miniatura (GET)

Obtém a imagem da miniatura para o ficheiro especificado.

Parâmetros

  • nome de arquivo: Nome, hex64 codificado, do ficheiro para o qual a miniatura está a ser solicitada

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

Começa uma gravação de realidade mista.

Parâmetros

  • holo: capturar hologramas: verdadeiros ou falsos (incumprimentos a falsos)
  • pv: capturar câmara PV: verdadeira ou falsa (incumprimentos a falsos)
  • microfone: microfone de captura: verdadeiro ou falso (incumprimentos a falsos)
  • loopback: capture o áudio da aplicação: verdadeiro ou falso (incumprimentos a falsos)
  • RenderFromCamera: (apenas HoloLens 2) renderizam do ponto de vista da câmara fotográfica/vídeo: verdadeiro ou falso (incumprimentos para verdade)
  • vstab: (apenas HoloLens 2) permitir a estabilização de vídeo: verdadeiro ou falso (incumprimentos verdadeiros)
  • vstabbuffer: (apenas HoloLens 2) latência do tampão de estabilização de vídeo: 0 a 30 fotogramas (padrão de 15 quadros)

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

Para a atual gravação de realidade mista.

Streaming de Realidade Mista

Atenção

Devido ao isolamento do loopback, não é possível ligar-se ao streaming de realidade mista a partir de dentro de uma aplicação num dispositivo.

HoloLens suporta a visualização ao vivo da realidade mista através do download de um mp4 fragmentado.

Os fluxos de realidade mista partilham o mesmo conjunto de parâmetros para controlar o que é capturado:

  • holo: capturar hologramas: verdadeiros ou falsos
  • pv: capturar câmara PV: verdadeiro ou falso
  • microfone: microfone de captura: verdadeiro ou falso
  • loopback: capture app audio: verdadeiro ou falso

Se nenhum destes for especificado, então hologramas, câmaras fotográficas e áudio de aplicações serão capturados.

Se algum for especificado, os parâmetros não especificados não serão falsos

Parâmetros opcionais (apenas HoloLens 2)

  • RenderFromCamera: render do ponto de vista da câmara fotográfica/vídeo: verdadeiro ou falso (incumprimentos para verdade)
  • vstab: permitir a estabilização de vídeo: verdadeiro ou falso (incumprimentos a falsos)
  • vstabbuffer: latência do tampão de estabilização de vídeo: 0 a 30 quadros (padrão de 15 quadros)

/api/holográfico/stream/live.mp4 (GET)

Um fluxo 1280x720p 30fps 5Mbit.

/api/holográfico/stream/live_high.mp4 (GET)

Um fluxo 1280x720p 30fps 5Mbit.

/api/holográfico/stream/live_med.mp4 (GET)

Um fluxo de 854x480p 30fps 2.5Mbit.

/api/holográfico/stream/live_low.mp4 (GET)

Um fluxo de 428x240p 15fps 0.6Mbit.

Rede

/api/networking/ipconfig (GET)

Obtém a configuração IP atual.

Informação do OS

/api/os/info (GET)

Obtém informação do sistema operativo.

/api/os/nome de máquina (GET)

Tem o nome da máquina.

/api/os/nome de máquina (POST)

Define o nome da máquina.

Parâmetros

  • nome: Novo nome da máquina, hex64 codificado, para definir para

Controlo de simulação de perceção

/api/holographic/simulação/controlo/modo (GET)

Obtém o modo de simulação.

/api/holographic/simulação/controlo/modo (POST)

Define o modo de simulação.

Parâmetros

  • modo: modo de simulação: padrão, simulação, remoto, legado

/api/holográfico/simulação/controlo/fluxo (DELETE)

Apague um fluxo de controlo.

/api/holographic/simulação/controlo/stream (GET/WebSocket)

Abra uma ligação WebSocket para um fluxo de controlo.

/api/holográfico/simulação/controlo/fluxo (POST)

Crie um fluxo de controlo (é necessária prioridade) ou poste dados para um fluxo criado (streamId necessário). Espera-se que os dados publicados sejam do tipo "aplicação/fluxo de octetos".

/api/holographic/simulação/display/stream (GET/WebSocket)

Solicite um fluxo de vídeo de simulação contendo o conteúdo prestado ao ecrã do sistema quando estiver no modo 'Simulação'. Um simples cabeçalho de descritor de formato será enviado inicialmente, seguido por texturas codificadas H.264, com cada um precedido por um cabeçalho indicando o índice ocular e o tamanho da textura.

Reprodução de simulação de perceção

/api/holográfico/simulação/reprodução/ficheiro (DELETE)

Apague uma gravação.

Parâmetros

  • gravação: Nome da gravação para apagar.

/api/holographic/simulação/reprodução/arquivo (POST)

Faça o upload de uma gravação.

/api/holographic/simulação/reprodução/ficheiros (GET)

Pegue todas as gravações.

/api/holographic/simulação/reprodução/sessão (GET)

Obtenha o estado atual de reprodução de uma gravação.

Parâmetros

  • gravação: Nome da gravação.

/api/holographic/simulação/reprodução/sessão/arquivo (DELETE)

Descarregue uma gravação.

Parâmetros

  • gravação: Nome da gravação para descarregar.

/api/holographic/simulação/reprodução/sessão/arquivo (POST)

Carrega uma gravação.

Parâmetros

  • gravação: Nome da gravação para carregar.

/api/holographic/simulação/reprodução/sessão/ficheiros (GET)

Pegue todas as gravações carregadas.

/api/holographic/simulação/reprodução/sessão/pausa (POST)

Faça uma pausa numa gravação.

Parâmetros

  • gravação: Nome da gravação.

/api/holographic/simulação/reprodução/sessão/reprodução (POST)

Toque uma gravação.

Parâmetros

  • gravação: Nome da gravação.

/api/holographic/simulação/reprodução/sessão/paragem (POST)

Pare uma gravação.

Parâmetros

  • gravação: Nome da gravação.

/api/holographic/simulação/reprodução/sessão/tipos (GET)

Obtenha os tipos de dados numa gravação carregada.

Parâmetros

  • gravação: Nome da gravação.

Gravação de simulação de perceção

/api/holográfico/simulação/gravação/início (POST)

Inicie uma gravação. Apenas uma única gravação pode estar ativa de uma só vez. Um destes deve ser definido: cabeça, mãos, ordenamento do território ou ambiente.

Parâmetros

  • cabeça: Definir para 1 para registar dados de cabeça.
  • mãos: Definir para 1 para gravar dados manuais.
  • mapear espacialmenteMapping: set to 1 para gravar mapeamento espacial.
  • ambiente: Definir para 1 para registar dados ambientais.
  • nome: Nome da gravação.
  • singleSpatialMappingFrame: set to 1 para gravar apenas uma única moldura de mapeamento espacial.

/api/holographic/simulação/gravação/estado (GET)

Obtenha o estado de gravação.

/api/holográfico/simulação/gravação/paragem (GET)

Pare a gravação atual. A gravação será devolvida como um ficheiro.

Dados de desempenho

/api/resourcemanager/processes (GET)

Devolve a lista de processos de execução com detalhes.

Dados de devolução

  • JSON com lista de processos e detalhes para cada processo

/api/resourcemanager/systemperf (GET)

Devolução de estatísticas do sistema perf (I/S read/write, estatísticas de memória, etc.

Dados de devolução

  • JSON com informações do sistema: CPU, GPU, Memória, Rede, IO

Energia

/api/energia/bateria (GET)

Obtém o estado atual da bateria.

/api/power/state (GET)

Verifica se o sistema está num estado de baixa potência.

Controlo Remoto

/api/control/restart (POST)

Reinicia o dispositivo alvo.

/api/control/shutdown (POST)

Desliga o dispositivo alvo.

Gestor de Tarefas

/api/taskmanager/app (DELETE)

Para uma aplicação moderna.

Parâmetros

  • pacote: Nome completo do pacote de aplicações, hex64 codificado
  • forcestop: Forçar todos os processos a parar (=sim)

/api/taskmanager/app (POST)

Inicia uma aplicação moderna

Parâmetros

  • appid: PRAID de app para começar, hex64 codificado
  • pacote: Nome completo do pacote de aplicações, hex64 codificado

Gestão WiFi

/api/wifi/interfaces (GET)

Enumera interfaces de rede sem fios.

Dados de devolução

  • Lista de interfaces sem fios com detalhes (GUID, descrição, etc.)

/api/wifi/rede (DELETE)

Elimina um perfil associado a uma rede numa interface especificada.

Parâmetros

  • interface: guia de interface de rede
  • perfil: nome de perfil

/api/wifi/networks (GET)

Enumera redes sem fios na interface de rede especificada.

Parâmetros

  • interface: guia de interface de rede

Dados de devolução

  • Lista de redes sem fios encontradas na interface de rede com detalhes

/api/wifi/network (POST)

Liga ou desliga a uma rede na interface especificada.

Parâmetros

  • interface: guia de interface de rede
  • ssid: ssid, hex64 codificado, para ligar a
  • op: ligar ou desligar
  • criar profile: sim ou não
  • chave: chave partilhada, hex64 codificado

Gravador de desempenho Windows

/api/wpr/customtrace (POST)

Carrega um perfil WPR e começa a rastrear usando o perfil carregado.

Carga útil

  • corpo http em conformidade multi-parte

Dados de devolução

  • Devolve o estado da sessão WPR.

/api/wpr/status (GET)

Recupera o estado da sessão WPR

Dados de devolução

  • Estado da sessão da WPR.

/api/wpr/trace (GET)

Para uma sessão de rastreio de WPR (performance).

Dados de devolução

  • Devolve o arquivo ETL de traço

/api/wpr/trace (POST)

Inicia uma sessão de rastreio de WPR (performance).

Parâmetros

  • perfil: Nome do perfil. Os perfis disponíveis são armazenados em perfprofiles/profiles.json

Dados de devolução

  • No início, devolve o estado da sessão WPR.

Ver também