Informations de référence sur les API Device Portal pour HoloLensDevice Portal API reference for HoloLens

Dans Windows Device Portal, tout repose sur les API REST que vous pouvez utiliser pour accéder aux données et contrôler votre appareil par programme.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.

Système d’exploitation holographiqueHolographic OS

Obtenir la spécification HTTPS pour Device PortalGet HTTPS requirements for the Device Portal

RequêteRequest

Vous pouvez obtenir la spécification HTTPS pour Device Portal en utilisant le format de requête suivant.You can get the HTTPS requirements for the Device Portal by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/os/webmanagement/settings/https/api/holographic/os/webmanagement/settings/https

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir l’écart pupillaire stocké (IPD)Get the stored interpupillary distance (IPD)

RequêteRequest

Vous pouvez obtenir la valeur de l’écart pupillaire stocké en utilisant le format de requête suivant.You can get the stored IPD value by using the following request format. La valeur renvoyée est exprimée en millimètres.The value is returned in millimeters.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir une liste des fournisseurs ETW spécifiques HoloLensGet a list of HoloLens specific ETW providers

RequêteRequest

Vous pouvez obtenir une liste des fournisseurs ETW spécifiques HoloLens qui ne sont pas enregistrés avec le système en utilisant le format de requête suivant.You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/os/etw/customproviders/api/holographic/os/etw/customproviders

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Renvoie l’état de tous les services actifsReturn the state for all active services

RequêteRequest

Vous pouvez obtenir l’état de tous les services en cours d’exécution en utilisant le format de requête suivant.You can get the state of all services that are currently running by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/os/services/api/holographic/os/services

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir la spécification HTTPS pour Device PortalSet the HTTPS requirement for the Device Portal.

RequêteRequest

Vous pouvez obtenir la spécification HTTPS pour Device Portal en utilisant le format de requête suivant.You can set the HTTPS requirements for the Device Portal by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/management/settings/https/api/holographic/management/settings/https

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
obligatoirerequired (requis) Détermine si HTTPS est requis pour Device Portal.(required) Determines whether or not HTTPS is required for the Device Portal. Les valeurs possibles sont yes, no, et default.Possible values are yes, no, and default.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Définir l’écart pupillaire (IPD)Set the interpupillary distance (IPD)

RequêteRequest

Vous pouvez définir l’écart pupillaire stocké en utilisant le format de requête suivant.You can set the stored IPD by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
ipdipd (requis) Nouvelle valeur IPD à stocker.(required) The new IPD value to be stored. Cette valeur doit être exprimée en millimètres.This value should be in millimeters.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Perception holographiqueHolographic perception

Accepter les mises à niveau websocket et exécuter un client mirage qui envoie des mises à jourAccept websocket upgrades and run a mirage client that sends updates

RequêteRequest

Vous pouvez accepter les mises à niveau websocket et exécuter un client mirage qui envoie des mises à jour à 30 fps en utilisant le format de requête suivant.You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

MéthodeMethod URI de requêteRequest URI
GET/WebSocketGET/WebSocket /api/holographic/perception/client/api/holographic/perception/client

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
clientmodeclientmode (requis) Détermine le mode de suivi.(required) Determines the tracking mode. La valeur active force le passage en mode de suivi visuel lorsqu’il est impossible de l’établir de manière passive.A value of active forces visual tracking mode when it can't be established passively.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Thermique holographiqueHolographic thermal

Obtenir la phase thermique de l’appareilGet the thermal stage of the device

RequêteRequest

Vous pouvez obtenir la phase thermique de l’appareil en utilisant le format de requête suivant.You can get the thermal stage of the device by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic//api/holographic/

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

Les valeurs possibles sont indiquées par le tableau suivant.The possible values are indicated by the following table.

ValeurValue DescriptionDescription
11 NormalNormal
22 ChargéWarm
33 CritiqueCritical

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Contrôle HSimulationHSimulation control

Créer un flux de contrôle ou publier des données dans un flux crééCreate a control stream or post data to a created stream

RequêteRequest

Vous pouvez créer un flux de contrôle ou publier des données dans un flux créé en utilisant le format de requête suivant.You can create a control stream or post data to a created stream by using the following request format. Les données publiées doivent être de type application/octet-stream.The posted data is expected to be of type application/octet-stream.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
prioritypriority (requis en cas de création d’un flux de contrôle) Indique la priorité du flux.(required if creating a control stream) Indicates the priority of the stream.
streamidstreamid (requis en cas de publication dans un flux créé) Identifiant du flux dans lequel publier.(required if posting to a created stream) The identifier for the stream to post to.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Supprimer un flux de contrôleDelete a control stream

RequêteRequest

Vous pouvez supprimer un flux de contrôle en utilisant le format de requête suivant.You can delete a control stream by using the following request format.

MéthodeMethod URI de requêteRequest URI
DELETEDELETE /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir un flux de contrôleGet a control stream

RequêteRequest

Vous pouvez ouvrir une connexion web socket pour un flux de contrôle en utilisant le format de requête suivant.You can open a web socket connection for a control stream by using the following request format.

MéthodeMethod URI de requêteRequest URI
GET/WebSocketGET/WebSocket /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir le mode de simulationGet the simulation mode

RequêteRequest

Vous pouvez obtenir le mode de simulation en utilisant le format de requête suivant.You can get the simluation mode by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/control/mode/api/holographic/simulation/control/mode

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Définir le mode de simulationSet the simulation mode

RequêteRequest

Vous pouvez définir le mode de simulation en utilisant le format de requête suivant.You can set the simulation mode by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simluation/control/mode/api/holographic/simluation/control/mode

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
modemode (requis) Indique le mode de simulation.(required) Indicates the simulation mode. Les valeurs possibles sont default, simulation, remote, et legacy.Possible values include default, simulation, remote, and legacy.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Lecture HSimulationHSimulation playback

Supprimer un enregistrementDelete a recording

RequêteRequest

Vous pouvez supprimer un enregistrement en utilisant le format de requête suivant.You can delete a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
DELETEDELETE /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à supprimer.(required) The name of the recording to delete.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir tous les enregistrementsGet all recordings

RequêteRequest

Vous pouvez obtenir tous les enregistrements disponibles en utilisant le format de requête suivant.You can get all the available recordings by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/playback/files/api/holographic/simulation/playback/files

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir les types de données dans un enregistrement chargéGet the types of data in a loaded recording

RequêteRequest

Vous pouvez obtenir les types de données dans un enregistrement chargé en utilisant le format suivant de la demande.You can get the types of data in a loaded recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/playback/session/types/api/holographic/simulation/playback/session/types

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement qui vous intéresse.(required) The name of the recording you are interested in.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir tous les enregistrements chargésGet all the loaded recordings

RequêteRequest

Vous pouvez obtenir tous les enregistrements chargés en utilisant le format de requête suivant.You can get all the loaded recordings by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/playback/session/files/api/holographic/simulation/playback/session/files

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir l’état actuel de lecture d’un enregistrementGet the current playback state of a recording

RequêteRequest

Vous pouvez obtenir l’état actuel de lecture d’un enregistrement en utilisant le format de requête suivant.You can get the current playback state of a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/playback/session/api/holographic/simulation/playback/session

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement qui vous intéresse.(required) The name of the recording that you are interested in.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Charger un enregistrementLoad a recording

RequêteRequest

Vous pouvez charger un enregistrement en utilisant le format de requête suivant.You can load a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à charger.(required) The name of the recording to load.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Suspendre un enregistrementPause a recording

RequêteRequest

Vous pouvez suspendre un enregistrement en utilisant le format de requête suivant.You can pause a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/playback/session/pause/api/holographic/simulation/playback/session/pause

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à suspendre.(required) The name of the recording to pause.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Lire un enregistrementPlay a recording

RequêteRequest

Vous pouvez lire un enregistrement en utilisant le format de requête suivant.You can play a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/playback/session/play/api/holographic/simulation/playback/session/play

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à lire.(required) The name of the recording to play.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Arrêter un enregistrementStop a recording

RequêteRequest

Vous pouvez arrêter un enregistrement en utilisant le format de requête suivant.You can stop a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/playback/session/stop/api/holographic/simulation/playback/session/stop

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à arrêter.(required) The name of the recording to stop.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Décharger un enregistrementUnload a recording

RequêteRequest

Vous pouvez décharger un enregistrement en utilisant le format de requête suivant.You can unload a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
DELETEDELETE /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
recordingrecording (requis) Nom de l’enregistrement à décharger.(required) The name of the recording to unload.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Charger un enregistrementUpload a recording

RequêteRequest

Vous pouvez décharger un enregistrement en utilisant le format de requête suivant.You can upload a recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Enregistrement HSimulationHSimulation recording

Obtenir l’état de l’enregistrementGet the recording state

RequêteRequest

Vous pouvez obtenir l’état d’enregistrement actuel en utilisant le format de requête suivant.You can get the current recording state by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/simulation/recording/status/api/holographic/simulation/recording/status

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Démarrer un enregistrementStart a recording

RequêteRequest

Vous pouvez démarrer un enregistrement en utilisant le format de requête suivant.You can start a recording by using the following request format. Vous ne pouvez effectuer qu’un seul enregistrement actif à la fois.There can only be one active recording at a time.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/recording/start/api/holographic/simulation/recording/start

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
headhead (voir ci-dessous) Définissez cette valeur sur 1 pour indiquer que le système doit enregistrer des données de tête.(see below) Set this value to 1 to indicate the system should record head data.
handshands (voir ci-dessous) Définissez cette valeur sur 1 pour indiquer que le système doit enregistrer des données hands.(see below) Set this value to 1 to indicate the system should record hands data.
spatialMappingspatialMapping (voir ci-dessous) Définissez cette valeur sur 1 pour indiquer que le système doit enregistrer des données de mappage spatial.(see below) Set this value to 1 to indicate the system should record spatial mapping data.
environmentenvironment (voir ci-dessous) Définissez cette valeur sur 1 pour indiquer que le système doit enregistrer des données d’environnement.(see below) Set this value to 1 to indicate the system should record environment data.
namename (requis) Nom de l’enregistrement.(required) The name of the recording.
singleSpatialMappingFramesingleSpatialMappingFrame (facultatif) Définissez cette valeur à 1 pour indiquer qu’une seule trame de mappage spatial doit être enregistrée.(optional) Set this value to 1 to indicate that only a single sptial mapping frame should be recorded.

Pour ces paramètres, un des paramètres suivants doit être défini sur 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.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Arrêter l’enregistrement en coursStop the current recording

RequêteRequest

Vous pouvez arrêter l’enregistrement en cours en utilisant le format de requête suivant.You can stop the current recording by using the following request format. L’enregistrement est renvoyé sous forme de fichier.The recording will be returned as a file.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/simulation/recording/stop/api/holographic/simulation/recording/stop

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

MRC (Mixed Reality Capture)Mixed reality capture

Supprimer un enregistrement MRC à partir de l’appareilDelete a mixed reality capture (MRC) recording from the device

RequêteRequest

Vous pouvez supprimer un enregistrement MRC en utilisant le format de requête suivant.You can delete an MRC recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
DELETEDELETE /api/holographic/mrc/file/api/holographic/mrc/file

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
nom_fichierfilename (requis) Nom du fichier vidéo à supprimer.(required) The name of the video file to delete. Ce nom doit être codé en hex64.The name should be hex64 encoded.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Télécharger un fichier MRCDownload a mixed reality capture (MRC) file

RequêteRequest

Vous pouvez télécharger un fichier MRC à partir de l’appareil en utilisant le format de requête suivant.You can download an MRC file from the device by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/mrc/file/api/holographic/mrc/file

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
nom_fichierfilename (requis) Nom du fichier vidéo que vous souhaitez obtenir.(required) The name of the video file you want to get. Ce nom doit être codé en hex64.The name should be hex64 encoded.
opop (facultatif) Définissez cette valeur sur stream si vous voulez télécharger un flux.(optional) Set this value to stream if you want to download a stream.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir les paramètres MRCGet the mixed reality capture (MRC) settings

RequêteRequest

Vous pouvez obtenir les paramètres MRC en utilisant le format de requête suivant.You can get the MRC settings by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/mrc/settings/api/holographic/mrc/settings

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir l’état de l’enregistrement MRCGet the status of the mixed reality capture (MRC) recording

RequêteRequest

Vous pouvez obtenir l’état de l’enregistrement MRC en utilisant le format de requête suivant.You can get the MRC recording status by using the following request format. Les valeurs possibles sont running et stopped.The possible values include running and stopped.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/mrc/status/api/holographic/mrc/status

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Obtenir la liste des fichiers MRCGet the list of mixed reality capture (MRC) files

RequêteRequest

Vous pouvez obtenir les fichiers MRC stockés sur l’appareil en utilisant le format de requête suivant.You can get the MRC files stored on the device by using the following request format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/mrc/files/api/holographic/mrc/files

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Définir les paramètres MRCSet the mixed reality capture (MRC) settings

RequêteRequest

Vous pouvez définir les paramètres MRC en utilisant le format de requête suivant.You can set the MRC settings by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/mrc/settings/api/holographic/mrc/settings

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Démarre un enregistrement MRCStarts a mixed reality capture (MRC) recording

RequêteRequest

Vous pouvez démarrer un enregistrement MRC en utilisant le format de requête suivant.You can start an MRC recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/mrc/video/control/start/api/holographic/mrc/video/control/start

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Arrêter l’enregistrement MRC actuelStop the current mixed reality capture (MRC) recording

RequêteRequest

Vous pouvez arrêter l’enregistrement MRC actuel en utilisant le format de requête suivant.You can stop the current MRC recording by using the following request format.

MéthodeMethod URI de requêteRequest URI
POSTPOST /api/holographic/mrc/video/control/stop/api/holographic/mrc/video/control/stop

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Prendre une photo MRCTake a mixed reality capture (MRC) photo

RequêteRequest

Vous pouvez prendre une photo MRC en utilisant le format de requête suivant.You can take an MRC photo by using the following request format. La photo est renvoyée au format JPEG.The photo is returned in JPEG format.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/mrc/photo/api/holographic/mrc/photo

Paramètres d’URIURI parameters

  • AucuneNone

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Diffusion en continu de la réalité mixéeMixed reality streaming

Initie un téléchargement mémorisé en bloc d’un mp4 fragmentéInitiates a chunked download of a fragmented mp4

RequêteRequest

Vous pouvez lancer un téléchargement mémorisé en bloc d’un mp4 fragmenté en utilisant le format de requête suivant.You can initiate a chunked download of a fragmented mp4 by using the following request format. Cette API utilise la qualité par défaut.This API uses the default quality.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/stream/live.mp4/api/holographic/stream/live.mp4

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
pvpv (facultatif) Indique si vous souhaitez capturer la caméra PV.(optional) Indiates whether to capture the PV camera. La valeur doit être true ou false.Should be true or false.
holoholo (facultatif) Indique si vous souhaitez capturer des hologrammes.(optional) Indiates whether to capture holograms. La valeur doit être true ou false.Should be true or false.
micmic (facultatif) Indique si vous souhaitez capturer le microphone.(optional) Indiates whether to capture the microphone. La valeur doit être true ou false.Should be true or false.
loopbackloopback (facultatif) Indique si vous souhaitez capturer le son de l’application.(optional) Indiates whether to capture the application audio. La valeur doit être true ou false.Should be true or false.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Initie un téléchargement mémorisé en bloc d’un mp4 fragmentéInitiates a chunked download of a fragmented mp4

RequêteRequest

Vous pouvez lancer un téléchargement mémorisé en bloc d’un mp4 fragmenté en utilisant le format de requête suivant.You can initiate a chunked download of a fragmented mp4 by using the following request format. Cette API utilise une qualité de niveau élevé.This API uses the high quality.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/stream/live_high.mp4/api/holographic/stream/live_high.mp4

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
pvpv (facultatif) Indique si vous souhaitez capturer la caméra PV.(optional) Indiates whether to capture the PV camera. La valeur doit être true ou false.Should be true or false.
holoholo (facultatif) Indique si vous souhaitez capturer des hologrammes.(optional) Indiates whether to capture holograms. La valeur doit être true ou false.Should be true or false.
micmic (facultatif) Indique si vous souhaitez capturer le microphone.(optional) Indiates whether to capture the microphone. La valeur doit être true ou false.Should be true or false.
loopbackloopback (facultatif) Indique si vous souhaitez capturer le son de l’application.(optional) Indiates whether to capture the application audio. La valeur doit être true ou false.Should be true or false.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Initie un téléchargement mémorisé en bloc d’un mp4 fragmentéInitiates a chunked download of a fragmented mp4

RequêteRequest

Vous pouvez lancer un téléchargement mémorisé en bloc d’un mp4 fragmenté en utilisant le format de requête suivant.You can initiate a chunked download of a fragmented mp4 by using the following request format. Cette API utilise une qualité de niveau faible.This API uses the low quality.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/stream/live_low.mp4/api/holographic/stream/live_low.mp4

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
pvpv (facultatif) Indique si vous souhaitez capturer la caméra PV.(optional) Indiates whether to capture the PV camera. La valeur doit être true ou false.Should be true or false.
holoholo (facultatif) Indique si vous souhaitez capturer des hologrammes.(optional) Indiates whether to capture holograms. La valeur doit être true ou false.Should be true or false.
micmic (facultatif) Indique si vous souhaitez capturer le microphone.(optional) Indiates whether to capture the microphone. La valeur doit être true ou false.Should be true or false.
loopbackloopback (facultatif) Indique si vous souhaitez capturer le son de l’application.(optional) Indiates whether to capture the application audio. La valeur doit être true ou false.Should be true or false.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.

Initie un téléchargement mémorisé en bloc d’un mp4 fragmentéInitiates a chunked download of a fragmented mp4

RequêteRequest

Vous pouvez lancer un téléchargement mémorisé en bloc d’un mp4 fragmenté en utilisant le format de requête suivant.You can initiate a chunked download of a fragmented mp4 by using the following request format. Cette API utilise une qualité de niveau moyenne.This API uses the medium quality.

MéthodeMethod URI de requêteRequest URI
GETGET /api/holographic/stream/live_med.mp4/api/holographic/stream/live_med.mp4

Paramètres d’URIURI parameters

Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :You can specify the following additional parameters on the request URI:

Paramètre d’URIURI parameter DescriptionDescription
pvpv (facultatif) Indique si vous souhaitez capturer la caméra PV.(optional) Indiates whether to capture the PV camera. La valeur doit être true ou false.Should be true or false.
holoholo (facultatif) Indique si vous souhaitez capturer des hologrammes.(optional) Indiates whether to capture holograms. La valeur doit être true ou false.Should be true or false.
micmic (facultatif) Indique si vous souhaitez capturer le microphone.(optional) Indiates whether to capture the microphone. La valeur doit être true ou false.Should be true or false.
loopbackloopback (facultatif) Indique si vous souhaitez capturer le son de l’application.(optional) Indiates whether to capture the application audio. La valeur doit être true ou false.Should be true or false.

En-têtes de requêteRequest headers

  • AucuneNone

Corps de demandeRequest body

  • AucuneNone

RéponseResponse

  • AucuneNone

Code d'étatStatus code

  • Codes d’état standard.Standard status codes.