Referência de API do Device Portal para HoloLensDevice Portal API reference for HoloLens

Tudo no Windows Device Portal foi criado com base em APIs REST, que você pode usar para acessar os dados e controlar o dispositivo de forma programática.Everything in the Windows Device Portal is built on top of REST API's that you can use to access the data and control your device programmatically.

Sistema operacional holográficoHolographic OS

Obter requisitos de HTTPS para o Device PortalGet HTTPS requirements for the Device Portal

SolicitaçãoRequest

Você pode obter os requisitos de HTTPS para o Device Portal usando o seguinte formato de solicitação:You can get the HTTPS requirements for the Device Portal by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/os/webmanagement/settings/https/api/holographic/os/webmanagement/settings/https

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter a DIP (distância interpupilar) armazenadaGet the stored interpupillary distance (IPD)

SolicitaçãoRequest

Você pode obter o valor armazenado da DIP usando o seguinte formato de solicitação:You can get the stored IPD value by using the following request format. O valor é retornado em milímetros.The value is returned in millimeters.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter uma lista de provedores ETW específicos do HoloLensGet a list of HoloLens specific ETW providers

SolicitaçãoRequest

Você pode obter uma lista de provedores ETW específicos do HoloLens que não são registrados no sistema usando o seguinte formato de solicitação:You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/os/etw/customproviders/api/holographic/os/etw/customproviders

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Retornar o estado para todos os serviços de ativosReturn the state for all active services

SolicitaçãoRequest

Você pode obter o estado de todos os serviços em execução no momento usando o seguinte formato de solicitação:You can get the state of all services that are currently running by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/os/services/api/holographic/os/services

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Defina o requisito de HTTPS para o Device Portal.Set the HTTPS requirement for the Device Portal.

SolicitaçãoRequest

Você pode definir os requisitos de HTTPS para o Device Portal usando o seguinte formato de solicitação:You can set the HTTPS requirements for the Device Portal by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/management/settings/https/api/holographic/management/settings/https

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
necessáriasrequired (necessário) Determina se o HTTPS é necessário ou não para o Device Portal.(required) Determines whether or not HTTPS is required for the Device Portal. Os valores possíveis são yes, no e default.Possible values are yes, no, and default.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Definir a DIP (distância interpupilar)Set the interpupillary distance (IPD)

SolicitaçãoRequest

Você pode definir a DIP armazenada usando o seguinte formato de solicitação:You can set the stored IPD by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
ipdipd (necessário) O novo valor da DIP a ser armazenado.(required) The new IPD value to be stored. Esse valor deve ser em milímetros.This value should be in millimeters.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Percepção holográficaHolographic perception

Aceitar atualizações Websocket e executar um cliente do Mirage que envia atualizaçõesAccept websocket upgrades and run a mirage client that sends updates

SolicitaçãoRequest

Você pode aceitar atualizações Websocket e executar um cliente do Mirage que envia atualizações em 30 fps usando o seguinte formato de solicitação:You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GET/WebSocketGET/WebSocket /api/holographic/perception/client/api/holographic/perception/client

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
clientmodeclientmode (necessário) Determina o modo de rastreamento.(required) Determines the tracking mode. Um valor active força o modo de rastreamento visual quando ele não pode ser estabelecido passivamente.A value of active forces visual tracking mode when it can't be established passively.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Térmico holográficoHolographic thermal

Obter o estágio térmico do dispositivoGet the thermal stage of the device

SolicitaçãoRequest

Você pode obter o estágio térmico do dispositivo usando o seguinte formato de solicitação:You can get the thermal stage of the device by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic//api/holographic/

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

Os valores possíveis são indicados pela tabela a seguir.The possible values are indicated by the following table.

ValorValue DescriçãoDescription
11 NormalNormal
22 MornoWarm
33 CríticoCritical

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Controle de HSimulationHSimulation control

Criar um fluxo de controle ou postar dados em um fluxo criadoCreate a control stream or post data to a created stream

SolicitaçãoRequest

Você pode criar um fluxo de controle ou postar dados em um fluxo criado usando o seguinte formato de solicitação:You can create a control stream or post data to a created stream by using the following request format. Espera-se que os dados postados sejam do tipo application/octet-stream.The posted data is expected to be of type application/octet-stream.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
prioridadepriority (necessário na criação de um fluxo de controle) Indica a prioridade do fluxo.(required if creating a control stream) Indicates the priority of the stream.
streamidstreamid (necessário na postagem em um fluxo criado) O identificador do fluxo no qual postar.(required if posting to a created stream) The identifier for the stream to post to.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Excluir um fluxo de controleDelete a control stream

SolicitaçãoRequest

Você pode excluir um fluxo de controle usando o seguinte formato de solicitação:You can delete a control stream by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
DELETEDELETE /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter um fluxo de controleGet a control stream

SolicitaçãoRequest

Você pode abrir uma conexão de soquete da Web para um fluxo de controle usando o seguinte formato de solicitação:You can open a web socket connection for a control stream by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GET/WebSocketGET/WebSocket /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter o modo de simulaçãoGet the simulation mode

SolicitaçãoRequest

Você pode obter o modo de simulação usando o seguinte formato de solicitação:You can get the simluation mode by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/control/mode/api/holographic/simulation/control/mode

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Definir o modo de simulaçãoSet the simulation mode

SolicitaçãoRequest

Você pode definir o modo de simulação usando o seguinte formato de solicitação:You can set the simulation mode by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simluation/control/mode/api/holographic/simluation/control/mode

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
modomode (necessário) Indica o modo de simulação.(required) Indicates the simulation mode. Os valores possíveis incluem default, simulation, remote e legacy.Possible values include default, simulation, remote, and legacy.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Reprodução de HSimulationHSimulation playback

Excluir uma gravaçãoDelete a recording

SolicitaçãoRequest

Você pode excluir uma gravação usando o seguinte formato de solicitação:You can delete a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
DELETEDELETE /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser excluída.(required) The name of the recording to delete.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter todas as gravaçõesGet all recordings

SolicitaçãoRequest

Você pode obter todas as gravações disponíveis usando o seguinte formato de solicitação:You can get all the available recordings by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/playback/files/api/holographic/simulation/playback/files

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter os tipos de dados em uma gravação carregadaGet the types of data in a loaded recording

SolicitaçãoRequest

Você pode obter os tipos de dados em uma gravação carregada usando o seguinte formato de solicitação:You can get the types of data in a loaded recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/playback/session/types/api/holographic/simulation/playback/session/types

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação pela qual você se interessa.(required) The name of the recording you are interested in.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter todas as gravações carregadasGet all the loaded recordings

SolicitaçãoRequest

Você pode obter todas as gravações carregadas disponíveis usando o seguinte formato de solicitação:You can get all the loaded recordings by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/playback/session/files/api/holographic/simulation/playback/session/files

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter o estado de reprodução atual de uma gravaçãoGet the current playback state of a recording

SolicitaçãoRequest

Você pode obter o estado de reprodução atual de uma gravação usando o seguinte formato de solicitação:You can get the current playback state of a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/playback/session/api/holographic/simulation/playback/session

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação pela qual você se interessa.(required) The name of the recording that you are interested in.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Carregar uma gravaçãoLoad a recording

SolicitaçãoRequest

Você pode carregar uma gravação usando o seguinte formato de solicitação:You can load a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser carregada.(required) The name of the recording to load.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Pausar uma gravaçãoPause a recording

SolicitaçãoRequest

Você pode pausar uma gravação usando o seguinte formato de solicitação:You can pause a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/playback/session/pause/api/holographic/simulation/playback/session/pause

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser pausada.(required) The name of the recording to pause.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Reproduzir uma gravaçãoPlay a recording

SolicitaçãoRequest

Você pode reproduzir uma gravação usando o seguinte formato de solicitação:You can play a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/playback/session/play/api/holographic/simulation/playback/session/play

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser reproduzida.(required) The name of the recording to play.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Parar a gravaçãoStop a recording

SolicitaçãoRequest

Você pode parar uma gravação usando o seguinte formato de solicitação:You can stop a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/playback/session/stop/api/holographic/simulation/playback/session/stop

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser parada.(required) The name of the recording to stop.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Descarregar uma gravaçãoUnload a recording

SolicitaçãoRequest

Você pode descarregar uma gravação usando o seguinte formato de solicitação:You can unload a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
DELETEDELETE /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
gravaçãorecording (necessário) O nome da gravação a ser descarregada.(required) The name of the recording to unload.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Carregar uma gravaçãoUpload a recording

SolicitaçãoRequest

Você pode carregar uma gravação usando o seguinte formato de solicitação:You can upload a recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Gravação de HSimulationHSimulation recording

Obter o estado de gravaçãoGet the recording state

SolicitaçãoRequest

Você pode obter a estado de gravação atual usando o seguinte formato de solicitação:You can get the current recording state by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/simulation/recording/status/api/holographic/simulation/recording/status

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Iniciar uma gravaçãoStart a recording

SolicitaçãoRequest

Você pode iniciar uma gravação usando o seguinte formato de solicitação:You can start a recording by using the following request format. Só é possível haver uma gravação ativa por vez.There can only be one active recording at a time.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/recording/start/api/holographic/simulation/recording/start

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
headhead (veja abaixo) Defina esse valor como 1 para indicar que o sistema deve gravar dados da cabeça.(see below) Set this value to 1 to indicate the system should record head data.
handshands (veja abaixo) Defina esse valor como 1 para indicar que o sistema deve gravar dados das mãos.(see below) Set this value to 1 to indicate the system should record hands data.
spatialMappingspatialMapping (veja abaixo) Defina esse valor como 1 para indicar que o sistema deve gravar dados do mapeamento espacial.(see below) Set this value to 1 to indicate the system should record spatial mapping data.
environmentenvironment (veja abaixo) Defina esse valor como 1 para indicar que o sistema deve gravar dados do ambiente.(see below) Set this value to 1 to indicate the system should record environment data.
namename (necessário) O nome da gravação.(required) The name of the recording.
singleSpatialMappingFramesingleSpatialMappingFrame (opcional) Defina esse valor como 1 para indicar que somente um único quadro de mapeamento espacial deve ser gravado.(optional) Set this value to 1 to indicate that only a single sptial mapping frame should be recorded.

Para esses parâmetros, um dos seguintes parâmetros deve ser definido exatamente como 1: head, hands, spatialMapping ou environment.For these parameters, exactly one of the following parameters must be set to 1: head, hands, spatialMapping, or environment.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Parar a gravação atualStop the current recording

SolicitaçãoRequest

Você pode parar a gravação atual usando o seguinte formato de solicitação:You can stop the current recording by using the following request format. A gravação será retornada como um arquivo.The recording will be returned as a file.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/simulation/recording/stop/api/holographic/simulation/recording/stop

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Captura de realidade mistaMixed reality capture

Excluir uma gravação MRC (captura de realidade mista) do dispositivoDelete a mixed reality capture (MRC) recording from the device

SolicitaçãoRequest

Você pode excluir uma gravação MRC usando o seguinte formato de solicitação:You can delete an MRC recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
DELETEDELETE /api/holographic/mrc/file/api/holographic/mrc/file

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
filenamefilename (necessário) O nome do arquivo de vídeo a ser excluído.(required) The name of the video file to delete. O nome deve ser codificado em hex64.The name should be hex64 encoded.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Baixar um arquivo de MRC (captura de realidade mista)Download a mixed reality capture (MRC) file

SolicitaçãoRequest

Você pode baixar um arquivo de MRC do dispositivo usando o seguinte formato de solicitação:You can download an MRC file from the device by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/mrc/file/api/holographic/mrc/file

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
filenamefilename (necessário) O nome do arquivo de vídeo que você deseja obter.(required) The name of the video file you want to get. O nome deve ser codificado em hex64.The name should be hex64 encoded.
opop (opcional) Defina esse valor como stream se você deseja baixar um fluxo.(optional) Set this value to stream if you want to download a stream.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter as configurações de MRC (captura de realidade mista)Get the mixed reality capture (MRC) settings

SolicitaçãoRequest

Você pode obter as configurações de MRC usando o seguinte formato de solicitação:You can get the MRC settings by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/mrc/settings/api/holographic/mrc/settings

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter o status da gravação de MRC (captura de realidade mista)Get the status of the mixed reality capture (MRC) recording

SolicitaçãoRequest

Você pode obter o status da gravação de MRC usando o seguinte formato de solicitação:You can get the MRC recording status by using the following request format. Os valores possíveis incluem running e stopped.The possible values include running and stopped.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/mrc/status/api/holographic/mrc/status

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Obter a lista de arquivos de MRC (captura de realidade mista)Get the list of mixed reality capture (MRC) files

SolicitaçãoRequest

Você pode obter os arquivos de MRC armazenados no dispositivo usando o seguinte formato de solicitação:You can get the MRC files stored on the device by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/mrc/files/api/holographic/mrc/files

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Definir as configurações de MRC (captura de realidade mista)Set the mixed reality capture (MRC) settings

SolicitaçãoRequest

Você pode definir as configurações de MRC usando o seguinte formato de solicitação:You can set the MRC settings by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/mrc/settings/api/holographic/mrc/settings

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Iniciar uma gravação de MRC (captura de realidade mista)Starts a mixed reality capture (MRC) recording

SolicitaçãoRequest

Você pode iniciar uma gravação de MRC usando o seguinte formato de solicitação:You can start an MRC recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/mrc/video/control/start/api/holographic/mrc/video/control/start

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Parar a atual gravação de MRC (captura de realidade mista)Stop the current mixed reality capture (MRC) recording

SolicitaçãoRequest

Você pode parar a atual gravação de MRC usando o seguinte formato de solicitação:You can stop the current MRC recording by using the following request format.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST /api/holographic/mrc/video/control/stop/api/holographic/mrc/video/control/stop

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Tirar uma foto de MRC (captura de realidade mista)Take a mixed reality capture (MRC) photo

SolicitaçãoRequest

Você pode tirar uma foto de MRC usando o seguinte formato de solicitação:You can take an MRC photo by using the following request format. A foto é retornada no formato JPEG.The photo is returned in JPEG format.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/mrc/photo/api/holographic/mrc/photo

Parâmetros do URIURI parameters

  • NãoNone

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Streaming de realidade mistaMixed reality streaming

Inicia um download em partes de um mp4 fragmentadoInitiates a chunked download of a fragmented mp4

SolicitaçãoRequest

Você pode iniciar um download em partes de um mp4 fragmentado usando o seguinte formato de solicitação:You can initiate a chunked download of a fragmented mp4 by using the following request format. Esta API usa a qualidade padrão.This API uses the default quality.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/stream/live.mp4/api/holographic/stream/live.mp4

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
pvpv (opcional) Indica se deve ser capturada a câmera PV.(optional) Indiates whether to capture the PV camera. Deve ser true ou false.Should be true or false.
holoholo (opcional) Indica se devem ser capturados hologramas.(optional) Indiates whether to capture holograms. Deve ser true ou false.Should be true or false.
micmic (opcional) Indica se deve ser capturado o microfone.(optional) Indiates whether to capture the microphone. Deve ser true ou false.Should be true or false.
loopbackloopback (opcional) Indica se deve ser capturado o áudio do aplicativo.(optional) Indiates whether to capture the application audio. Deve ser true ou false.Should be true or false.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Inicia um download em partes de um mp4 fragmentadoInitiates a chunked download of a fragmented mp4

SolicitaçãoRequest

Você pode iniciar um download em partes de um mp4 fragmentado usando o seguinte formato de solicitação:You can initiate a chunked download of a fragmented mp4 by using the following request format. Esta API usa a alta qualidade.This API uses the high quality.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/stream/live_high.mp4/api/holographic/stream/live_high.mp4

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
pvpv (opcional) Indica se deve ser capturada a câmera PV.(optional) Indiates whether to capture the PV camera. Deve ser true ou false.Should be true or false.
holoholo (opcional) Indica se devem ser capturados hologramas.(optional) Indiates whether to capture holograms. Deve ser true ou false.Should be true or false.
micmic (opcional) Indica se deve ser capturado o microfone.(optional) Indiates whether to capture the microphone. Deve ser true ou false.Should be true or false.
loopbackloopback (opcional) Indica se deve ser capturado o áudio do aplicativo.(optional) Indiates whether to capture the application audio. Deve ser true ou false.Should be true or false.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Inicia um download em partes de um mp4 fragmentadoInitiates a chunked download of a fragmented mp4

SolicitaçãoRequest

Você pode iniciar um download em partes de um mp4 fragmentado usando o seguinte formato de solicitação:You can initiate a chunked download of a fragmented mp4 by using the following request format. Esta API usa a baixa qualidade.This API uses the low quality.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/stream/live_low.mp4/api/holographic/stream/live_low.mp4

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
pvpv (opcional) Indica se deve ser capturada a câmera PV.(optional) Indiates whether to capture the PV camera. Deve ser true ou false.Should be true or false.
holoholo (opcional) Indica se devem ser capturados hologramas.(optional) Indiates whether to capture holograms. Deve ser true ou false.Should be true or false.
micmic (opcional) Indica se deve ser capturado o microfone.(optional) Indiates whether to capture the microphone. Deve ser true ou false.Should be true or false.
loopbackloopback (opcional) Indica se deve ser capturado o áudio do aplicativo.(optional) Indiates whether to capture the application audio. Deve ser true ou false.Should be true or false.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.

Inicia um download em partes de um mp4 fragmentadoInitiates a chunked download of a fragmented mp4

SolicitaçãoRequest

Você pode iniciar um download em partes de um mp4 fragmentado usando o seguinte formato de solicitação:You can initiate a chunked download of a fragmented mp4 by using the following request format. Esta API usa a qualidade média.This API uses the medium quality.

MétodoMethod URI da solicitaçãoRequest URI
GETGET /api/holographic/stream/live_med.mp4/api/holographic/stream/live_med.mp4

Parâmetros do URIURI parameters

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:You can specify the following additional parameters on the request URI:

Parâmetro do URIURI parameter DescriçãoDescription
pvpv (opcional) Indica se deve ser capturada a câmera PV.(optional) Indiates whether to capture the PV camera. Deve ser true ou false.Should be true or false.
holoholo (opcional) Indica se devem ser capturados hologramas.(optional) Indiates whether to capture holograms. Deve ser true ou false.Should be true or false.
micmic (opcional) Indica se deve ser capturado o microfone.(optional) Indiates whether to capture the microphone. Deve ser true ou false.Should be true or false.
loopbackloopback (opcional) Indica se deve ser capturado o áudio do aplicativo.(optional) Indiates whether to capture the application audio. Deve ser true ou false.Should be true or false.

Cabeçalhos de solicitaçãoRequest headers

  • NãoNone

Corpo da solicitaçãoRequest body

  • NãoNone

RespostaResponse

  • NãoNone

Código de StatusStatus code

  • Códigos de status padrão.Standard status codes.