Referenz zu Geräteportal-APIs für HoloLensDevice Portal API reference for HoloLens

Alle Komponenten im Windows Device Portal basieren auf REST-APIs, die Sie für den Zugriff auf die Daten und die programmatische Steuerung des Geräts verwenden können.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.

Holographic – BetriebssystemHolographic OS

Abrufen der HTTPS-Anforderungen für das GeräteportalGet HTTPS requirements for the Device Portal

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die HTTPS-Anforderungen für das Geräteportal abrufen.You can get the HTTPS requirements for the Device Portal by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/os/webmanagement/settings/https/api/holographic/os/webmanagement/settings/https

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen des gespeicherten Pupillenabstands (Interpupillary Distance, IPD)Get the stored interpupillary distance (IPD)

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den gespeicherten IPD-Wert abrufen.You can get the stored IPD value by using the following request format. Der Wert wird in Millimeter zurückgegeben.The value is returned in millimeters.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen einer Liste mit ETW-Anbietern für HoloLensGet a list of HoloLens specific ETW providers

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Liste mit ETW-Anbietern für HoloLens abrufen, die nicht im System registriert sind.You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/os/etw/customproviders/api/holographic/os/etw/customproviders

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Gibt den Status für alle aktiven Dienste zurück.Return the state for all active services

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den Status aller Dienste abrufen, die derzeit ausgeführt werden.You can get the state of all services that are currently running by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/os/services/api/holographic/os/services

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Festlegen der HTTPS-Anforderung für das GeräteportalSet the HTTPS requirement for the Device Portal.

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die HTTPS-Anforderungen für das Geräteportal festlegen.You can set the HTTPS requirements for the Device Portal by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/management/settings/https/api/holographic/management/settings/https

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Erforderlichrequired (Erforderlich) Bestimmt, ob für das Geräteportal HTTPS erforderlich ist.(required) Determines whether or not HTTPS is required for the Device Portal. Die möglichen Werte lauten yes, no und default.Possible values are yes, no, and default.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Festlegen des Pupillenabstands (Interpupillary Distance, IPD)Set the interpupillary distance (IPD)

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den gespeicherten IPD-Wert festlegen.You can set the stored IPD by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
ipdipd (erforderlich) Der neue IPD-Wert, der gespeichert werden soll.(required) The new IPD value to be stored. Dieser Wert sollte in Millimeter angegeben werden.This value should be in millimeters.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Holographic – WahrnehmungHolographic perception

Akzeptieren von WebSocket-Upgrades und Ausführen eines Mirage-Clients, der Updates sendetAccept websocket upgrades and run a mirage client that sends updates

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie WebSocket-Upgrades akzeptieren und einen Mirage-Client ausführen, der Updates mit 30 fps sendet.You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GET/WebSocketGET/WebSocket /api/holographic/perception/client/api/holographic/perception/client

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
clientmodeclientmode (erforderlich) Bestimmt den Nachverfolgungsmodus.(required) Determines the tracking mode. Mit dem Wert active wird der visuelle Nachverfolgungsmodus erzwungen, wenn er nicht passiv erreicht werden kann.A value of active forces visual tracking mode when it can't be established passively.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Holographic – WärmeHolographic thermal

Abrufen des Wärmestatus des GerätsGet the thermal stage of the device

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den Wärmestatus des Geräts abrufen.You can get the thermal stage of the device by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic//api/holographic/

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

In der folgenden Tabelle werden die möglichen Werte angegeben.The possible values are indicated by the following table.

ValueValue BeschreibungDescription
11 NormalNormal
22 Normal AuslastungWarm
33 KritischCritical

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

HSimulation-SteuerungHSimulation control

Erstellen eines Steuerungsdatenstroms oder Senden von Daten an einen erstellten DatenstromCreate a control stream or post data to a created stream

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie einen Steuerungsdatenstrom erstellen oder Daten an einen erstellten Datenstrom senden.You can create a control stream or post data to a created stream by using the following request format. Die gesendeten Daten müssen vom Typ application/octet-stream sein.The posted data is expected to be of type application/octet-stream.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
prioritypriority (erforderlich, wenn ein Steuerungsdatenstrom erstellt wird) Gibt die Priorität des Datenstroms an.(required if creating a control stream) Indicates the priority of the stream.
streamidstreamid (erforderlich, wenn an einen erstellten Datenstrom gesendet wird) Der Bezeichner für den Datenstrom, an den gesendet werden soll.(required if posting to a created stream) The identifier for the stream to post to.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Löschen eines SteuerungsdatenstromsDelete a control stream

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie einen Steuerungsdatenstrom löschen.You can delete a control stream by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
DELETEDELETE /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen eines Steuerungsdatenstroms.Get a control stream

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine WebSocket-Verbindung für einen Steuerungsdatenstrom öffnen.You can open a web socket connection for a control stream by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GET/WebSocketGET/WebSocket /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen des SimulationsmodusGet the simulation mode

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den Simulationsmodus abrufen.You can get the simluation mode by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/control/mode/api/holographic/simulation/control/mode

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Festlegen des SimulationsmodusSet the simulation mode

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den Simulationsmodus festlegen.You can set the simulation mode by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simluation/control/mode/api/holographic/simluation/control/mode

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
modemode (erforderlich) Gibt den Simulationsmodus an.(required) Indicates the simulation mode. Die möglichen Werte lauten default, simulation, remote und legacy.Possible values include default, simulation, remote, and legacy.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

HSimulation-WiedergabeHSimulation playback

Löschen einer AufzeichnungDelete a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung löschen.You can delete a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
DELETEDELETE /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der zu löschenden Aufzeichnung.(required) The name of the recording to delete.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen aller AufzeichnungenGet all recordings

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie alle verfügbaren Aufzeichnungen abrufen.You can get all the available recordings by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/playback/files/api/holographic/simulation/playback/files

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen der Typen von Daten in einer geladenen AufzeichnungGet the types of data in a loaded recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die Typen der Daten in einer geladenen Aufzeichnung abrufen.You can get the types of data in a loaded recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/playback/session/types/api/holographic/simulation/playback/session/types

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der betreffenden Aufzeichnung.(required) The name of the recording you are interested in.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen aller geladenen AufzeichnungenGet all the loaded recordings

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie alle geladenen Aufzeichnungen abrufen.You can get all the loaded recordings by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/playback/session/files/api/holographic/simulation/playback/session/files

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen des aktuellen Wiedergabestatus einer AufzeichnungGet the current playback state of a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den aktuellen Wiedergabestatus einer Aufzeichnung abrufen.You can get the current playback state of a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/playback/session/api/holographic/simulation/playback/session

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der betreffenden Aufzeichnung.(required) The name of the recording that you are interested in.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Laden einer AufzeichnungLoad a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung laden.You can load a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der zu ladenden Aufzeichnung.(required) The name of the recording to load.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Anhalten einer AufzeichnungPause a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung anhalten.You can pause a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/pause/api/holographic/simulation/playback/session/pause

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der anzuhaltenden Aufzeichnung.(required) The name of the recording to pause.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Wiedergeben einer AufzeichnungPlay a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung wiedergeben.You can play a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/play/api/holographic/simulation/playback/session/play

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der wiederzugebenden Aufzeichnung.(required) The name of the recording to play.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Beenden einer AufzeichnungStop a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung beenden.You can stop a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/stop/api/holographic/simulation/playback/session/stop

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der zu beendenden Aufzeichnung.(required) The name of the recording to stop.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Entladen einer AufzeichnungUnload a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung entladen.You can unload a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
DELETEDELETE /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Aufzeichnungrecording (erforderlich) Der Name der zu entladenden Aufzeichnung.(required) The name of the recording to unload.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Hochladen einer AufzeichnungUpload a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung hochladen.You can upload a recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

HSimulation-AufzeichnungHSimulation recording

Abrufen des AufzeichnungsstatusGet the recording state

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den aktuellen Aufzeichnungsstatus abrufen.You can get the current recording state by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/simulation/recording/status/api/holographic/simulation/recording/status

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Starten einer AufzeichnungStart a recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine Aufzeichnung starten.You can start a recording by using the following request format. Es kann nur jeweils eine aktive Aufzeichnung vorhanden sein.There can only be one active recording at a time.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/recording/start/api/holographic/simulation/recording/start

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
headhead (siehe unten) Legen Sie diesen Wert auf 1 fest, um anzugeben, dass das System Kopfdaten aufzeichnen soll.(see below) Set this value to 1 to indicate the system should record head data.
handshands (siehe unten) Legen Sie diesen Wert auf 1 fest, um anzugeben, dass das System Handdaten aufzeichnen soll.(see below) Set this value to 1 to indicate the system should record hands data.
spatialMappingspatialMapping (siehe unten) Legen Sie diesen Wert auf 1 fest, um anzugeben, dass das System Spatial-Mapping-Daten aufzeichnen soll.(see below) Set this value to 1 to indicate the system should record spatial mapping data.
environmentenvironment (siehe unten) Legen Sie diesen Wert auf 1 fest, um anzugeben, dass das System Umgebungsdaten aufzeichnen soll.(see below) Set this value to 1 to indicate the system should record environment data.
Namename (erforderlich) Der Name der Aufzeichnung.(required) The name of the recording.
singleSpatialMappingFramesingleSpatialMappingFrame (optional) Legen Sie diesen Wert auf 1 fest, um anzugeben, dass nur ein einzelner Spatial-Mapping-Frame aufgezeichnet werden soll.(optional) Set this value to 1 to indicate that only a single sptial mapping frame should be recorded.

Für diese Parameter muss genau einer der folgenden Parameter auf 1 festgelegt werden: head, hands, spatialMapping oder environment.For these parameters, exactly one of the following parameters must be set to 1: head, hands, spatialMapping, or environment.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Beenden der aktuellen AufzeichnungStop the current recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die aktuelle Aufzeichnung beenden.You can stop the current recording by using the following request format. Die Aufzeichnung wird als Datei zurückgegeben.The recording will be returned as a file.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/simulation/recording/stop/api/holographic/simulation/recording/stop

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Mixed-Reality-AufnahmeMixed reality capture

Löschen einer Mixed Reality-Aufnahme (Mixed Reality Capture, MRC) vom GerätDelete a mixed reality capture (MRC) recording from the device

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine MRC-Aufzeichnung löschen.You can delete an MRC recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
DELETEDELETE /api/holographic/mrc/file/api/holographic/mrc/file

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Dateinamefilename (erforderlich) Der Name der zu löschenden Videodatei.(required) The name of the video file to delete. Der Name sollte hex64-codiert sein.The name should be hex64 encoded.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Herunterladen einer MRC-Datei (Mixed Reality Capture)Download a mixed reality capture (MRC) file

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine MRC-Datei vom Gerät herunterladen.You can download an MRC file from the device by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/mrc/file/api/holographic/mrc/file

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
Dateinamefilename (erforderlich) Der Name der Videodatei, die Sie abrufen möchten.(required) The name of the video file you want to get. Der Name sollte hex64-codiert sein.The name should be hex64 encoded.
opop (optional) Legen Sie diesen Wert auf stream fest, wenn Sie einen Datenstrom herunterladen möchten.(optional) Set this value to stream if you want to download a stream.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen der MRC-Einstellungen (Mixed Reality Capture)Get the mixed reality capture (MRC) settings

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die MRC-Einstellungen abrufen.You can get the MRC settings by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/mrc/settings/api/holographic/mrc/settings

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen des Status der MRC-Aufzeichnung (Mixed Reality Capture)Get the status of the mixed reality capture (MRC) recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den Status der MRC-Aufzeichnung abrufen.You can get the MRC recording status by using the following request format. Mögliche Werte: running und stopped.The possible values include running and stopped.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/mrc/status/api/holographic/mrc/status

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Abrufen der Liste der MRC-Dateien (Mixed Reality Capture)Get the list of mixed reality capture (MRC) files

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die auf dem Gerät gespeicherten MRC-Dateien abrufen.You can get the MRC files stored on the device by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/mrc/files/api/holographic/mrc/files

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Festlegen der MRC-Einstellungen (Mixed Reality Capture)Set the mixed reality capture (MRC) settings

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die MRC-Einstellungen festlegen.You can set the MRC settings by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/mrc/settings/api/holographic/mrc/settings

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Starten einer MRC-Aufzeichnung (Mixed Reality Capture)Starts a mixed reality capture (MRC) recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie eine MRC-Aufzeichnung starten.You can start an MRC recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/mrc/video/control/start/api/holographic/mrc/video/control/start

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Beenden der aktuellen MRC-Aufzeichnung (Mixed Reality Capture)Stop the current mixed reality capture (MRC) recording

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie die aktuelle MRC-Aufzeichnung beenden.You can stop the current MRC recording by using the following request format.

MethodeMethod Anforderungs-URIRequest URI
POSTPOST /api/holographic/mrc/video/control/stop/api/holographic/mrc/video/control/stop

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Aufnehmen eines MRC-Fotos (Mixed Reality Capture)Take a mixed reality capture (MRC) photo

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie ein MRC-Foto aufnehmen.You can take an MRC photo by using the following request format. Das Foto wird im JPEG-Format zurückgegeben.The photo is returned in JPEG format.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/mrc/photo/api/holographic/mrc/photo

URI-ParameterURI parameters

  • KeineNone

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Mixed-Reality-StreamingMixed reality streaming

Starten des portionsweisen Downloads einer fragmentierten MP4-DateiInitiates a chunked download of a fragmented mp4

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den portionsweisen Download einer fragmentierten MP4-Datei starten.You can initiate a chunked download of a fragmented mp4 by using the following request format. Diese API verwendet die Standardqualität.This API uses the default quality.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/stream/live.mp4/api/holographic/stream/live.mp4

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
pvpv (optional) Gibt an, ob Aufnahmen der Foto-/Videokamera aufgezeichnet werden sollen.(optional) Indiates whether to capture the PV camera. Sollte true oder false sein.Should be true or false.
holoholo (optional) Gibt an, ob Hologramme aufgezeichnet werden sollen.(optional) Indiates whether to capture holograms. Sollte true oder false sein.Should be true or false.
micmic (optional) Gibt an, ob Aufnahmen des Mikrofons aufgezeichnet werden sollen.(optional) Indiates whether to capture the microphone. Sollte true oder false sein.Should be true or false.
loopbackloopback (optional) Gibt an, ob Audioaufnahmen der Anwendung aufgezeichnet werden sollen.(optional) Indiates whether to capture the application audio. Sollte true oder false sein.Should be true or false.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Starten des portionsweisen Downloads einer fragmentierten MP4-DateiInitiates a chunked download of a fragmented mp4

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den portionsweisen Download einer fragmentierten MP4-Datei starten.You can initiate a chunked download of a fragmented mp4 by using the following request format. Diese API verwendet die hohe Qualität.This API uses the high quality.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/stream/live_high.mp4/api/holographic/stream/live_high.mp4

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
pvpv (optional) Gibt an, ob Aufnahmen der Foto-/Videokamera aufgezeichnet werden sollen.(optional) Indiates whether to capture the PV camera. Sollte true oder false sein.Should be true or false.
holoholo (optional) Gibt an, ob Hologramme aufgezeichnet werden sollen.(optional) Indiates whether to capture holograms. Sollte true oder false sein.Should be true or false.
micmic (optional) Gibt an, ob Aufnahmen des Mikrofons aufgezeichnet werden sollen.(optional) Indiates whether to capture the microphone. Sollte true oder false sein.Should be true or false.
loopbackloopback (optional) Gibt an, ob Audioaufnahmen der Anwendung aufgezeichnet werden sollen.(optional) Indiates whether to capture the application audio. Sollte true oder false sein.Should be true or false.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Starten des portionsweisen Downloads einer fragmentierten MP4-DateiInitiates a chunked download of a fragmented mp4

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den portionsweisen Download einer fragmentierten MP4-Datei starten.You can initiate a chunked download of a fragmented mp4 by using the following request format. Diese API verwendet die niedrige Qualität.This API uses the low quality.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/stream/live_low.mp4/api/holographic/stream/live_low.mp4

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
pvpv (optional) Gibt an, ob Aufnahmen der Foto-/Videokamera aufgezeichnet werden sollen.(optional) Indiates whether to capture the PV camera. Sollte true oder false sein.Should be true or false.
holoholo (optional) Gibt an, ob Hologramme aufgezeichnet werden sollen.(optional) Indiates whether to capture holograms. Sollte true oder false sein.Should be true or false.
micmic (optional) Gibt an, ob Aufnahmen des Mikrofons aufgezeichnet werden sollen.(optional) Indiates whether to capture the microphone. Sollte true oder false sein.Should be true or false.
loopbackloopback (optional) Gibt an, ob Audioaufnahmen der Anwendung aufgezeichnet werden sollen.(optional) Indiates whether to capture the application audio. Sollte true oder false sein.Should be true or false.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.

Starten des portionsweisen Downloads einer fragmentierten MP4-DateiInitiates a chunked download of a fragmented mp4

AnforderungRequest

Mit dem folgenden Anforderungsformat können Sie den portionsweisen Download einer fragmentierten MP4-Datei starten.You can initiate a chunked download of a fragmented mp4 by using the following request format. Diese API verwendet die mittlere Qualität.This API uses the medium quality.

MethodeMethod Anforderungs-URIRequest URI
GETGET /api/holographic/stream/live_med.mp4/api/holographic/stream/live_med.mp4

URI-ParameterURI parameters

Sie können im Anforderungs-URI die folgenden zusätzlichen Parameter angeben:You can specify the following additional parameters on the request URI:

URI-ParameterURI parameter BeschreibungDescription
pvpv (optional) Gibt an, ob Aufnahmen der Foto-/Videokamera aufgezeichnet werden sollen.(optional) Indiates whether to capture the PV camera. Sollte true oder false sein.Should be true or false.
holoholo (optional) Gibt an, ob Hologramme aufgezeichnet werden sollen.(optional) Indiates whether to capture holograms. Sollte true oder false sein.Should be true or false.
micmic (optional) Gibt an, ob Aufnahmen des Mikrofons aufgezeichnet werden sollen.(optional) Indiates whether to capture the microphone. Sollte true oder false sein.Should be true or false.
loopbackloopback (optional) Gibt an, ob Audioaufnahmen der Anwendung aufgezeichnet werden sollen.(optional) Indiates whether to capture the application audio. Sollte true oder false sein.Should be true or false.

AnforderungsheaderRequest headers

  • KeineNone

AnforderungstextRequest body

  • KeineNone

AntwortResponse

  • KeineNone

StatuscodeStatus code

  • StandardstatuscodesStandard status codes.