HoloLens 用 Device Portal API リファレンス

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

ホログラフィック OS


Device Portal の HTTPS 要件を取得する

要求

次の要求型式を使用して、Device Portal の HTTPS 要件を取得できます。

メソッド 要求 URI
GET /api/holographic/os/webmanagement/settings/https

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

保存されている瞳孔間距離 (IPD) を取得する

要求

次の要求型式を使用して、保存されている IPD の値を取得できます。 値はミリメートル単位で返されます。

メソッド 要求 URI
GET /api/holographic/os/settings/ipd

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

HoloLens 固有の ETW プロバイダーの一覧を取得する

要求

次の要求型式を使用して、システムには登録されていない HoloLens 固有の ETW プロバイダーの一覧を取得できます。

メソッド 要求 URI
GET /api/holographic/os/etw/customproviders

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

アクティブなすべてのサービスの状態を返す

要求

次の要求形式を使用して、現在実行されているすべてのサービスの状態を取得できます。

メソッド 要求 URI
GET /api/holographic/os/services

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

Device Portal の HTTPS 要件を設定する

要求

次の要求形式を使用して、Device Portal の HTTPS 要件を設定できます。

メソッド 要求 URI
POST /api/holographic/management/settings/https

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
required (必須) Device Portal で HTTPS を必要とするかどうかを決定します。 指定できる値は、yesnodefault です。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

瞳孔間距離 (IPD) を設定する

要求

次の要求形式を使用して、保存されている IPD を設定できます。

メソッド 要求 URI
POST /api/holographic/os/settings/ipd

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
ipd (必須) 保存する新しい IPD 値。 この値はミリメートル単位で指定します。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

ホログラフィックの認識


WebSocket のアップグレードを受け入れ、ミラージュ クライアントを実行する

要求

次の要求型式を使用して、WebSocket のアップグレードを受け入れ、30fps で更新を送信するミラージュ クライアントを実行できます。

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

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
clientmode (必須) 追跡モードを決定します。 値を active に設定すると、パッシブに確立できない場合は視覚追跡モードが強制されます。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

ホログラフィックの温度


デバイスの温度ステージを取得する

要求

次の要求形式を使用して、デバイスの温度ステージを取得できます。

メソッド 要求 URI
GET /api/holographic/

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

返される可能性のある値を次の表に示します。

説明
1 正常
2 中温
3 臨界

状態コード

  • 標準の状態コード。

HSimulation の制御


制御ストリームを作成する、または作成されたストリームにデータをポストする

要求

次の要求形式を使用して、制御ストリームを作成したり、作成されたストリームにデータをポストしたりできます。 ポストされるデータの種類は application/octet-stream と想定されます。

メソッド 要求 URI
POST /api/holographic/simulation/control/stream

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
priority (制御ストリームを作成する場合は必須) ストリームの優先度を示します。
streamid (作成されたストリームにポストする場合は必須) ポスト先のストリームの識別子。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

制御ストリームを削除する

要求

次の要求形式を使用して、制御ストリームを削除できます。

メソッド 要求 URI
DELETE /api/holographic/simulation/control/stream

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

制御ストリームを取得する

要求

次の要求形式を使用して、制御ストリームの Web ソケット接続を開くことができます。

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

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

シミュレーション モードを取得する

要求

次の要求形式を使用して、シミュレーション モードを取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/control/mode

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

シミュレーション モードを設定する

要求

次の要求型式を使用して、シミュレーション モードを設定できます。

メソッド 要求 URI
POST /api/holographic/simluation/control/mode

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
mode (必須) シミュレーション モードを示します。 指定できる値は、defaultsimulationremotelegacy です。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

HSimulation の再生


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

要求

次の要求型式を使用して、レコーディングを削除できます。

メソッド 要求 URI
DELETE /api/holographic/simulation/playback/file

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 削除するレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、利用可能なすべてのレコーディングを取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/playback/files

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

読み込まれたレコーディング内のデータの種類を取得する

要求

次の要求形式を使用して、読み込まれたレコーディング内のデータの種類を取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/playback/session/types

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 対象とするレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、読み込まれたすべてのレコーディングを取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/playback/session/files

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

レコーディングの現在の再生状態を取得する

要求

次の要求形式を使用して、レコーディングの現在の再生状態を取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/playback/session

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 対象とするレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングを読み込むことができます。

メソッド 要求 URI
POST /api/holographic/simulation/playback/session/file

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 読み込むレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングを一時停止できます。

メソッド 要求 URI
POST /api/holographic/simulation/playback/session/pause

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 一時停止するレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングを再生できます。

メソッド 要求 URI
POST /api/holographic/simulation/playback/session/play

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 再生するレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングを停止できます。

メソッド 要求 URI
POST /api/holographic/simulation/playback/session/stop

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) 停止するレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングをダウンロードできます。

メソッド 要求 URI
DELETE /api/holographic/simulation/playback/session/file

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
recording (必須) アンロードするレコーディングの名前。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングをアップロードできます。

メソッド 要求 URI
POST /api/holographic/simulation/playback/file

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

HSimulation のレコーディング


レコーディングの状態を取得する

要求

次の要求形式を使用して、現在のレコーディングの状態を取得できます。

メソッド 要求 URI
GET /api/holographic/simulation/recording/status

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

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

要求

次の要求形式を使用して、レコーディングを開始できます。 アクティブにできるレコーディングは一度に 1 つだけです。

メソッド 要求 URI
POST /api/holographic/simulation/recording/start

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
head (下記参照) システムで頭部のデータを記録する必要があることを示すには、この値を 1 に設定します。
hands (下記参照) システムで手のデータを記録する必要があることを示すには、この値を 1 に設定します。
spatialMapping (下記参照) システムで空間マッピング データを記録する必要があることを示すには、この値を 1 に設定します。
environment (下記参照) システムで環境データを記録する必要があることを示すには、この値を 1 に設定します。
name (必須) レコーディングの名前。
singleSpatialMappingFrame (省略可能) 単一の空間マッピング フレームのみを記録する必要があることを示すには、この値を 1 に設定します。

これらのパラメーターについては、headhandsspatialMappingenvironment のいずれか 1 つだけを 1 に設定する必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

現在のレコーディングを停止する

要求

次の要求形式を使用して、現在のレコーディングを停止できます。 レコーディングはファイルとして返されます。

メソッド 要求 URI
POST /api/holographic/simulation/recording/stop

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ


デバイスから複合現実キャプチャ (MRC) レコーディングを削除する

要求

次の要求形式を使用して、MRC レコーディングを削除できます。

メソッド 要求 URI
DELETE /api/holographic/mrc/file

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
filename (必須) 削除するビデオ ファイルの名前。 この名前は hex64 エンコードされている必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) ファイルをダウンロードする

要求

次の要求形式を使用して、デバイスから MRC ファイルをダウンロードできます。

メソッド 要求 URI
GET /api/holographic/mrc/file

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
filename (必須) 取得するビデオ ファイルの名前。 この名前は hex64 エンコードされている必要があります。
op (省略可能) ストリームをダウンロードする場合は、この値を stream に設定します。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) の設定を取得する

要求

次の要求形式を使用して、MRC の設定を取得できます。

メソッド 要求 URI
GET /api/holographic/mrc/settings

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) レコーディングの状態を取得する

要求

次の要求形式を使用して、MRC レコーディングの状態を取得できます。 返される可能性のある値は、runningstopped です。

メソッド 要求 URI
GET /api/holographic/mrc/status

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) ファイルのリストを取得する

要求

次の要求形式を使用して、デバイスに保存されている MRC ファイルを取得できます。

メソッド 要求 URI
GET /api/holographic/mrc/files

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) の設定を行う

要求

次の要求形式を使用して、MRC の設定を行うことができます。

メソッド 要求 URI
POST /api/holographic/mrc/settings

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) レコーディングを開始する

要求

次の要求形式を使用して、MRC レコーディングを開始できます。

メソッド 要求 URI
POST /api/holographic/mrc/video/control/start

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

現在の複合現実キャプチャ (MRC) レコーディングを停止する

要求

次の要求形式を使用して、現在の MRC レコーディングを停止できます。

メソッド 要求 URI
POST /api/holographic/mrc/video/control/stop

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実キャプチャ (MRC) の写真を撮る

要求

次の要求形式を使用して、MRC の写真を撮ることができます。 写真は JPEG 形式で返されます。

メソッド 要求 URI
GET /api/holographic/mrc/photo

URI パラメーター

  • なし

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

複合現実のストリーミング


フラグメント化 mp4 のチャンク ダウンロードを開始する

要求

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。 この API では既定の品質が使われます。

メソッド 要求 URI
GET /api/holographic/stream/live.mp4

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
pv (省略可能) PV カメラをキャプチャするかどうかを示します。 true または false を指定する必要があります。
holo (省略可能) ホログラムをキャプチャするかどうかを示します。 true または false を指定する必要があります。
mic (省略可能) マイクをキャプチャするかどうかを示します。 true または false を指定する必要があります。
loopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。 true または false を指定する必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

フラグメント化 mp4 のチャンク ダウンロードを開始する

要求

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。 この API では高品質が使われます。

メソッド 要求 URI
GET /api/holographic/stream/live_high.mp4

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
pv (省略可能) PV カメラをキャプチャするかどうかを示します。 true または false を指定する必要があります。
holo (省略可能) ホログラムをキャプチャするかどうかを示します。 true または false を指定する必要があります。
mic (省略可能) マイクをキャプチャするかどうかを示します。 true または false を指定する必要があります。
loopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。 true または false を指定する必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

フラグメント化 mp4 のチャンク ダウンロードを開始する

要求

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。 この API では低品質が使われます。

メソッド 要求 URI
GET /api/holographic/stream/live_low.mp4

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
pv (省略可能) PV カメラをキャプチャするかどうかを示します。 true または false を指定する必要があります。
holo (省略可能) ホログラムをキャプチャするかどうかを示します。 true または false を指定する必要があります。
mic (省略可能) マイクをキャプチャするかどうかを示します。 true または false を指定する必要があります。
loopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。 true または false を指定する必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。

フラグメント化 mp4 のチャンク ダウンロードを開始する

要求

次の要求型式を使用して、フラグメント化 mp4 のチャンク ダウンロードを開始できます。 この API では中品質が使われます。

メソッド 要求 URI
GET /api/holographic/stream/live_med.mp4

URI パラメーター

次の追加パラメーターを要求 URI に指定できます。

URI パラメーター 説明
pv (省略可能) PV カメラをキャプチャするかどうかを示します。 true または false を指定する必要があります。
holo (省略可能) ホログラムをキャプチャするかどうかを示します。 true または false を指定する必要があります。
mic (省略可能) マイクをキャプチャするかどうかを示します。 true または false を指定する必要があります。
loopback (省略可能) アプリケーション オーディオをキャプチャするかどうかを示します。 true または false を指定する必要があります。

要求ヘッダー

  • なし

要求本文

  • なし

応答

  • なし

状態コード

  • 標準の状態コード。