HoloLens 用 Device Portal API リファレンスDevice Portal API reference for HoloLens

Windows Device Portal の機能はすべて、REST API の上に構築されています。REST API は、プログラムからデータにアクセスしてデバイスを制御するために使用できます。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.

ホログラフィック OSHolographic OS


Device Portal の HTTPS 要件を取得するGet HTTPS requirements for the Device Portal

要求Request

次の要求型式を使用して、Device Portal の HTTPS 要件を取得できます。You can get the HTTPS requirements for the Device Portal by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/os/webmanagement/settings/https/api/holographic/os/webmanagement/settings/https

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

保存されている瞳孔間距離 (IPD) を取得するGet the stored interpupillary distance (IPD)

要求Request

次の要求型式を使用して、保存されている IPD の値を取得できます。You can get the stored IPD value by using the following request format. 値はミリメートル単位で返されます。The value is returned in millimeters.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

HoloLens 固有の ETW プロバイダーの一覧を取得するGet a list of HoloLens specific ETW providers

要求Request

次の要求型式を使用して、システムには登録されていない HoloLens 固有の ETW プロバイダーの一覧を取得できます。You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/os/etw/customproviders/api/holographic/os/etw/customproviders

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

アクティブなすべてのサービスの状態を返すReturn the state for all active services

要求Request

次の要求形式を使用して、現在実行されているすべてのサービスの状態を取得できます。You can get the state of all services that are currently running by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/os/services/api/holographic/os/services

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Device Portal の HTTPS 要件を設定するSet the HTTPS requirement for the Device Portal.

要求Request

次の要求形式を使用して、Device Portal の HTTPS 要件を設定できます。You can set the HTTPS requirements for the Device Portal by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/management/settings/https/api/holographic/management/settings/https

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
requiredrequired (必須) Device Portal で HTTPS を必要とするかどうかを決定します。(required) Determines whether or not HTTPS is required for the Device Portal. 指定できる値は、yesnodefault です。Possible values are yes, no, and default.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

瞳孔間距離 (IPD) を設定するSet the interpupillary distance (IPD)

要求Request

次の要求形式を使用して、保存されている IPD を設定できます。You can set the stored IPD by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
ipdipd (必須) 保存する新しい IPD 値。(required) The new IPD value to be stored. この値はミリメートル単位で指定します。This value should be in millimeters.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Holographic perception


WebSocket のアップグレードを受け入れ、ミラージュ クライアントを実行するAccept websocket upgrades and run a mirage client that sends updates

要求Request

次の要求型式を使用して、WebSocket のアップグレードを受け入れ、30fps で更新を送信するミラージュ クライアントを実行できます。You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

メソッドMethod 要求 URIRequest URI
GET/WebSocketGET/WebSocket /api/holographic/perception/client/api/holographic/perception/client

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
clientmodeclientmode (必須) 追跡モードを決定します。(required) Determines the tracking mode. 値を active に設定すると、パッシブに確立できない場合は視覚追跡モードが強制されます。A value of active forces visual tracking mode when it can't be established passively.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Holographic thermal


デバイスの温度ステージを取得するGet the thermal stage of the device

要求Request

次の要求形式を使用して、デバイスの温度ステージを取得できます。You can get the thermal stage of the device by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic//api/holographic/

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

返される可能性のある値を次の表に示します。The possible values are indicated by the following table.

Value 説明Description
11 正常Normal
22 中温Warm
33 重大Critical

状態コードStatus code

  • 標準の状態コード。Standard status codes.

HSimulation control


制御ストリームを作成する、または作成されたストリームにデータをポストするCreate a control stream or post data to a created stream

要求Request

次の要求形式を使用して、制御ストリームを作成したり、作成されたストリームにデータをポストしたりできます。You can create a control stream or post data to a created stream by using the following request format. ポストされるデータの種類は application/octet-stream と想定されます。The posted data is expected to be of type application/octet-stream.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
prioritypriority (制御ストリームを作成する場合は必須) ストリームの優先度を示します。(required if creating a control stream) Indicates the priority of the stream.
streamidstreamid (作成されたストリームにポストする場合は必須) ポスト先のストリームの識別子。(required if posting to a created stream) The identifier for the stream to post to.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

制御ストリームを削除するDelete a control stream

要求Request

次の要求形式を使用して、制御ストリームを削除できます。You can delete a control stream by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

制御ストリームを取得するGet a control stream

要求Request

次の要求形式を使用して、制御ストリームの Web ソケット接続を開くことができます。You can open a web socket connection for a control stream by using the following request format.

メソッドMethod 要求 URIRequest URI
GET/WebSocketGET/WebSocket /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

シミュレーション モードを取得するGet the simluation mode

要求Request

次の要求形式を使用して、シミュレーション モードを取得できます。You can get the simluation mode by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/control/mode/api/holographic/simulation/control/mode

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

シミュレーション モードを設定するSet the simluation mode

要求Request

次の要求型式を使用して、シミュレーション モードを設定できます。You can set the simulation mode by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simluation/control/mode/api/holographic/simluation/control/mode

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
modemode (必須) シミュレーション モードを示します。(required) Indicates the simulation mode. 指定できる値は、defaultsimulationremotelegacy です。Possible values include default, simulation, remote, and legacy.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

HSimulation playback


レコーディングを削除するDelete a recording

要求Request

次の要求型式を使用して、レコーディングを削除できます。You can delete a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 削除するレコーディングの名前。(required) The name of the recording to delete.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

すべてのレコーディングを取得するGet all recordings

要求Request

次の要求形式を使用して、利用可能なすべてのレコーディングを取得できます。You can get all the available recordings by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/playback/files/api/holographic/simulation/playback/files

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

読み込まれたレコーディング内のデータの種類を取得するGet the types of data in a loaded recording

要求Request

次の要求形式を使用して、読み込まれたレコーディング内のデータの種類を取得できます。You can get the types of data in a loaded recording by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/playback/session/types/api/holographic/simulation/playback/session/types

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 対象とするレコーディングの名前。(required) The name of the recording you are interested in.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

読み込まれたすべてのレコーディングを取得するGet all the loaded recordings

要求Request

次の要求形式を使用して、読み込まれたすべてのレコーディングを取得できます。You can get all the loaded recordings by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/playback/session/files/api/holographic/simulation/playback/session/files

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングの現在の再生状態を取得するGet the current playback state of a recording

要求Request

次の要求形式を使用して、レコーディングの現在の再生状態を取得できます。You can get the current playback state of a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/playback/session/api/holographic/simulation/playback/session

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 対象とするレコーディングの名前。(required) The name of the recording that you are interested in.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングを読み込むLoad a recording

要求Request

次の要求形式を使用して、レコーディングを読み込むことができます。You can load a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 読み込むレコーディングの名前。(required) The name of the recording to load.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングを一時停止するPause a recording

要求Request

次の要求形式を使用して、レコーディングを一時停止できます。You can pause a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/pause/api/holographic/simulation/playback/session/pause

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 一時停止するレコーディングの名前。(required) The name of the recording to pause.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングを再生するPlay a recording

要求Request

次の要求形式を使用して、レコーディングを再生できます。You can play a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/play/api/holographic/simulation/playback/session/play

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 再生するレコーディングの名前。(required) The name of the recording to play.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングを停止するStop a recording

要求Request

次の要求形式を使用して、レコーディングを停止できます。You can stop a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/playback/session/stop/api/holographic/simulation/playback/session/stop

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) 停止するレコーディングの名前。(required) The name of the recording to stop.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングをアンロードするUnload a recording

要求Request

次の要求形式を使用して、レコーディングをダウンロードできます。You can unload a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
recordingrecording (必須) アンロードするレコーディングの名前。(required) The name of the recording to unload.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングをアップロードするUpload a recording

要求Request

次の要求形式を使用して、レコーディングをアップロードできます。You can upload a recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

HSimulation recording


レコーディングの状態を取得するGet the recording state

要求Request

次の要求形式を使用して、現在のレコーディングの状態を取得できます。You can get the current recording state by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/simulation/recording/status/api/holographic/simulation/recording/status

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

レコーディングを開始するStart a recording

要求Request

次の要求形式を使用して、レコーディングを開始できます。You can start a recording by using the following request format. アクティブにできるレコーディングは一度に 1 つだけです。There can only be one active recording at a time.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/recording/start/api/holographic/simulation/recording/start

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
headhead (下記参照) システムで頭部のデータを記録する必要があることを示すには、この値を 1 に設定します。(see below) Set this value to 1 to indicate the system should record head data.
handshands (下記参照) システムで手のデータを記録する必要があることを示すには、この値を 1 に設定します。(see below) Set this value to 1 to indicate the system should record hands data.
spatialMappingspatialMapping (下記参照) システムで空間マッピング データを記録する必要があることを示すには、この値を 1 に設定します。(see below) Set this value to 1 to indicate the system should record spatial mapping data.
environmentenvironment (下記参照) システムで環境データを記録する必要があることを示すには、この値を 1 に設定します。(see below) Set this value to 1 to indicate the system should record environment data.
namename (必須) レコーディングの名前。(required) The name of the recording.
singleSpatialMappingFramesingleSpatialMappingFrame (省略可能) 単一の空間マッピング フレームのみを記録する必要があることを示すには、この値を 1 に設定します。(optional) Set this value to 1 to indicate that only a single sptial mapping frame should be recorded.

これらのパラメーターについては、headhandsspatialMappingenvironment のいずれか 1 つだけを 1 に設定する必要があります。For these parameters, exactly one of the following parameters must be set to 1: head, hands, spatialMapping, or environment.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

現在のレコーディングを停止するStop the current recording

要求Request

次の要求形式を使用して、現在のレコーディングを停止できます。You can stop the current recording by using the following request format. レコーディングはファイルとして返されます。The recording will be returned as a file.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/simulation/recording/stop/api/holographic/simulation/recording/stop

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed reality capture


デバイスから Mixed Reality キャプチャ (MRC) レコーディングを削除するDelete a mixed reality capture (MRC) recording from the device

要求Request

次の要求形式を使用して、MRC レコーディングを削除できます。You can delete an MRC recording by using the following request format.

メソッドMethod 要求 URIRequest URI
DELETEDELETE /api/holographic/mrc/file/api/holographic/mrc/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
filenamefilename (必須) 削除するビデオ ファイルの名前。(required) The name of the video file to delete. この名前は hex64 エンコードされている必要があります。The name should be hex64 encoded.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) ファイルをダウンロードするDownload a mixed reality capture (MRC) file

要求Request

次の要求形式を使用して、デバイスから MRC ファイルをダウンロードできます。You can download an MRC file from the device by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/mrc/file/api/holographic/mrc/file

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
filenamefilename (必須) 取得するビデオ ファイルの名前。(required) The name of the video file you want to get. この名前は hex64 エンコードされている必要があります。The name should be hex64 encoded.
opop (省略可能) ストリームをダウンロードする場合は、この値を stream に設定します。(optional) Set this value to stream if you want to download a stream.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) の設定を取得するGet the mixed reality capture (MRC) settings

要求Request

次の要求形式を使用して、MRC の設定を取得できます。You can get the MRC settings by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/mrc/settings/api/holographic/mrc/settings

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) レコーディングの状態を取得するGet the status of the mixed reality capture (MRC) recording

要求Request

次の要求形式を使用して、MRC レコーディングの状態を取得できます。You can get the MRC recording status by using the following request format. 返される可能性のある値は、runningstopped です。The possible values include running and stopped.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/mrc/status/api/holographic/mrc/status

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) ファイルのリストを取得するGet the list of mixed reality capture (MRC) files

要求Request

次の要求形式を使用して、デバイスに保存されている MRC ファイルを取得できます。You can get the MRC files stored on the device by using the following request format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/mrc/files/api/holographic/mrc/files

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) の設定を行うSet the mixed reality capture (MRC) settings

要求Request

次の要求形式を使用して、MRC の設定を行うことができます。You can set the MRC settings by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/mrc/settings/api/holographic/mrc/settings

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) レコーディングを開始するStarts a mixed reality capture (MRC) recording

要求Request

次の要求形式を使用して、MRC レコーディングを開始できます。You can start an MRC recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/mrc/video/control/start/api/holographic/mrc/video/control/start

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

現在の Mixed Reality キャプチャ (MRC) レコーディングを停止するStop the current mixed reality capture (MRC) recording

要求Request

次の要求形式を使用して、現在の MRC レコーディングを停止できます。You can stop the current MRC recording by using the following request format.

メソッドMethod 要求 URIRequest URI
POSTPOST /api/holographic/mrc/video/control/stop/api/holographic/mrc/video/control/stop

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed Reality キャプチャ (MRC) の写真を撮るTake a mixed reality capture (MRC) photo

要求Request

次の要求形式を使用して、MRC の写真を撮ることができます。You can take an MRC photo by using the following request format. 写真は JPEG 形式で返されます。The photo is returned in JPEG format.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/mrc/photo/api/holographic/mrc/photo

URI パラメーターURI parameters

  • なしNone

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

Mixed reality streaming


フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

要求Request

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。You can initiate a chunked download of a fragmented mp4 by using the following request format. この API では既定の品質が使われます。This API uses the default quality.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/stream/live.mp4/api/holographic/stream/live.mp4

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pvpv (省略可能) PV カメラをキャプチャするかどうかを示します。(optional) Indiates whether to capture the PV camera. true または false を指定する必要があります。Should be true or false.
holoholo (省略可能) ホログラムをキャプチャするかどうかを示します。(optional) Indiates whether to capture holograms. true または false を指定する必要があります。Should be true or false.
micmic (省略可能) マイクをキャプチャするかどうかを示します。(optional) Indiates whether to capture the microphone. true または false を指定する必要があります。Should be true or false.
loopbackloopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。(optional) Indiates whether to capture the application audio. true または false を指定する必要があります。Should be true or false.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

要求Request

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。You can initiate a chunked download of a fragmented mp4 by using the following request format. この API では高品質が使われます。This API uses the high quality.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/stream/live_high.mp4/api/holographic/stream/live_high.mp4

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pvpv (省略可能) PV カメラをキャプチャするかどうかを示します。(optional) Indiates whether to capture the PV camera. true または false を指定する必要があります。Should be true or false.
holoholo (省略可能) ホログラムをキャプチャするかどうかを示します。(optional) Indiates whether to capture holograms. true または false を指定する必要があります。Should be true or false.
micmic (省略可能) マイクをキャプチャするかどうかを示します。(optional) Indiates whether to capture the microphone. true または false を指定する必要があります。Should be true or false.
loopbackloopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。(optional) Indiates whether to capture the application audio. true または false を指定する必要があります。Should be true or false.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

要求Request

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。You can initiate a chunked download of a fragmented mp4 by using the following request format. この API では低品質が使われます。This API uses the low quality.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/stream/live_low.mp4/api/holographic/stream/live_low.mp4

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pvpv (省略可能) PV カメラをキャプチャするかどうかを示します。(optional) Indiates whether to capture the PV camera. true または false を指定する必要があります。Should be true or false.
holoholo (省略可能) ホログラムをキャプチャするかどうかを示します。(optional) Indiates whether to capture holograms. true または false を指定する必要があります。Should be true or false.
micmic (省略可能) マイクをキャプチャするかどうかを示します。(optional) Indiates whether to capture the microphone. true または false を指定する必要があります。Should be true or false.
loopbackloopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。(optional) Indiates whether to capture the application audio. true または false を指定する必要があります。Should be true or false.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.

フラグメント化 mp4 のチャンク ダウンロードを開始するInitiates a chunked download of a fragmented mp4

要求Request

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。You can initiate a chunked download of a fragmented mp4 by using the following request format. この API では中品質が使われます。This API uses the medium quality.

メソッドMethod 要求 URIRequest URI
GETGET /api/holographic/stream/live_med.mp4/api/holographic/stream/live_med.mp4

URI パラメーターURI parameters

次の追加パラメーターを要求 URI に指定できます。You can specify the following additional parameters on the request URI:

URI パラメーターURI parameter 説明Description
pvpv (省略可能) PV カメラをキャプチャするかどうかを示します。(optional) Indiates whether to capture the PV camera. true または false を指定する必要があります。Should be true or false.
holoholo (省略可能) ホログラムをキャプチャするかどうかを示します。(optional) Indiates whether to capture holograms. true または false を指定する必要があります。Should be true or false.
micmic (省略可能) マイクをキャプチャするかどうかを示します。(optional) Indiates whether to capture the microphone. true または false を指定する必要があります。Should be true or false.
loopbackloopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。(optional) Indiates whether to capture the application audio. true または false を指定する必要があります。Should be true or false.

要求ヘッダーRequest headers

  • なしNone

要求本文Request body

  • なしNone

応答Response

  • なしNone

状態コードStatus code

  • 標準の状態コード。Standard status codes.