Device Portal API リファレンス

[アーティクル]
07/12/2023

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

アプリの展開

/api/app/packagemanager/package (DELETE)

アプリをアンインストールします。

パラメーター

package: アンインストールするパッケージのファイル名。

/api/app/packagemanager/package (POST)

アプリをインストールします。

パラメーター

package: インストールするパッケージのファイル名。

ペイロード

マルチパート準拠の http 本文

/api/app/packagemanager/packages (GET)

システムにインストールされているアプリの一覧を取得します。詳細が含まれます。

データを返します

インストールされているパッケージの一覧と詳細

/api/app/packagemanager/state (GET)

進行中のアプリのインストール状態を取得します。

ダンプの収集

/api/debug/dump/usermode/crashcontrol (DELETE)

サイドロードされたアプリのクラッシュダンプコレクションを無効にします。

パラメーター

packageFullName: パッケージ名

/api/debug/dump/usermode/crashcontrol (GET)

サイドロードされたアプリのクラッシュダンプコレクションの設定を取得します。

パラメーター

packageFullName: パッケージ名

/api/debug/dump/usermode/crashcontrol (POST)

サイドロードされたアプリのダンプ制御設定を有効にし、設定します。

パラメーター

packageFullName: パッケージ名

/api/debug/dump/usermode/crashdump (DELETE)

サイドロードされたアプリのクラッシュダンプを削除します。

パラメーター

packageFullName: パッケージ名
fileName: ダンプファイル名

/api/debug/dump/usermode/crashdump (GET)

サイドロードされたアプリのクラッシュダンプを取得します。

パラメーター

packageFullName: パッケージ名
fileName: ダンプファイル名

データを返します

ダンプファイル。 WinDbg または Visual Studio を使って検査します。

/api/debug/dump/usermode/dumps (GET)

サイドロードされたアプリのすべてのクラッシュダンプの一覧を返します。

データを返します

サイドロードされたアプリごとのクラッシュダンプの一覧

ETW

/api/etw/providers (GET)

登録済みプロバイダーを列挙します。

データを返します

プロバイダー、フレンドリ名、GUID の一覧

/api/etw/session/realtime (GET/WebSocket)

リアルタイム ETW セッションを作成します。Websocket を使って管理されます。

データを返します

有効なプロバイダーからの ETW イベント

ホログラフィック OS

/api/holographic/os/etw/customproviders (GET)

システムに登録されていない HoloLens 固有の ETW プロバイダーの一覧を返します。

/api/holographic/os/services (GET)

実行中のすべてのサービスの状態を返します。

/api/holographic/os/settings/ipd (GET)

格納されている IPD (瞳孔間距離) をミリ単位で取得します。

/api/holographic/os/settings/ipd (POST)

IPD を設定します。

パラメーター

ipd: ミリ単位で設定される新しい IPD 値

/api/holographic/os/webmanagement/settings/https (GET)

デバイスポータルの HTTPS 要件を取得します。

/api/holographic/os/webmanagement/settings/https (POST)

デバイスポータルの HTTPS 要件を設定します。

パラメーター

required: yes、no、または default

ホログラフィックの認識

/api/holographic/perception/client (GET/WebSocket)

WebSocket のアップグレードを受け入れ、30 fps で更新プログラムを送信する認識クライアントを実行します。

パラメーター

clientmode: "active" に設定すると、パッシブに確立できない場合は視覚追跡モードが強制されます

ホログラフィックの温度

これらの温度 API を使用する場合は、電源と温度の管理に関する記事を参照してください。

/api/holographic/thermal/stage (GET)

デバイスの温度ステージを取得します (0 通常、1 中温、2 重大)。

/api/holographic/thermal/getMitigationLevels (GET/websocket)

Websocket を開き (または単一の HTTP GET クエリを実行して)、次を含むオブジェクトの一覧を返します。

IsSuppressed - 特定の周辺機器で軽減策が抑制されているかどうかを識別する
レベル - この周辺機器の最新の温度軽減レベル
マスク - この周辺機器のマスク
ThermalScore - この周辺機器の最新の温度スコア

オブジェクトの名前は周辺機器名 (例: バッテリー)

/api/holographic/thermal/setMitigationLevel (POST)

特定の周辺機器に対して報告される軽減レベルを変更する

パラメーター

mask: 目的の周辺機器に単一ビットが設定されたビットマスク (詳細については、「PowerThermalPeripheralFlags 」を参照してください)
level: 使用する新しいレベル (0 から 3)

/api/holographic/thermal/setThermalScore (POST)

特定の周辺機器に対して報告される温度スコアを変更する

パラメーター

mask: 目的の周辺機器に単一ビットが設定されたビットマスク (詳細については、「PowerThermalPeripheralFlags 」を参照してください)
thermalScore: 使用する新しい温度スコア (100-0)

Map Manager

/api/holographic/mapmanager/mapFiles (GET)

使用できるマップファイル (.mapx) の一覧を取得します。

/api/holographic/mapmanager/anchorFiles (GET)

使用できるアンカーファイル (.ancx) の一覧を取得します。

/api/holographic/mapmanager/srdbFiles (GET)

使用できる空間再構築データベースファイル (.srdb) の一覧を取得します。

/api/holographic/mapmanager/getanchors (GET)

現在のユーザーの永続化されたアンカーの一覧を取得します。

ファイルのダウンロード、アップロード、削除

/api/holographic/mapmanager/download (GET)

マップ、アンカー、または空間再構築データベースファイルをダウンロードします。ファイルはあらかじめアップロードまたはエクスポートされている必要があります。

パラメーター

FileName: ダウンロードするファイルの名前。

例:

$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)

/api/holographic/mapmanager/upload (POST)

マップ、アンカー、または空間再構築データベースファイルをアップロードします。ファイルがアップロードされると、後でシステムからインポートして使うことができます。

パラメーター

file: アップロードするファイルの名前。

例:

var form_data = new FormData();
form_data.append("file", file_data);

$.ajax({
    url: "/api/holographic/mapmanager/upload",
    dataType: 'json',
    cache: false,
    contentType: false,
    processData: false,
    data: form_data,
    type: 'post'
})

/api/holographic/mapmanager/delete (POST)

マップ、アンカー、または空間再構築データベースファイルを削除します。ファイルはあらかじめアップロードまたはエクスポートされている必要があります。

パラメーター

FileName: 削除するファイルの名前。

例:

$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)

エクスポート

/api/holographic/mapmanager/export (POST)

システムによって現在使われているマップをエクスポートします。エクスポートが完了すると、ダウンロードできます。

例:

$.post("/api/holographic/mapmanager/export")

/api/holographic/mapmanager/exportanchors (POST)

システムによって現在使われているマップをエクスポートします。エクスポートが完了すると、ダウンロードできます。例:

$.post("/api/holographic/mapmanager/exportanchors")

/api/holographic/mapmanager/exportmapandanchors (POST)

システムによって現在使われているマップおよびアンカーをエクスポートします。エクスポートが完了すると、ダウンロードできます。例:

$.post("/api/holographic/mapmanager/exportmapandanchors")

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

システムによって現在使われているマップと空間再構築データベースをエクスポートします。エクスポートが完了すると、ダウンロードできます。

例:

$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")

[インポート]

/api/holographic/mapmanager/import (POST)

マップを使う必要があることをシステムに示します。エクスポートまたはアップロードされたファイルに対して呼び出すことができます。

パラメーター

FileName: 使うマップの名前。

例:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importanchors (POST)

アンカーを使う必要があることをシステムに示します。エクスポートまたはアップロードされたファイルに対して呼び出すことができます。

パラメーター

FileName: 使われるアンカーの名前。

例:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importspatialmappingdb (POST)

空間再構築データベースを使う必要があることをシステムに示します。エクスポートまたはアップロードされたファイルに対して呼び出すことができます。

パラメーター

FileName: 使われる空間マッピングデータベースの名前。

例:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

その他

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

システムのマップ、アンカー、空間再構築データベースをリセットします。

例:

$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")

/api/holographic/mapmanager/status (GET)

どのマップ、アンカー、空間再構築データベースファイルが最後にインポートされたかなど、システムの状態を取得します。

Mixed Reality キャプチャ

/api/holographic/mrc/file (GET)

デバイスから Mixed Reality ファイルをダウンロードします。ストリーミングには op=stream クエリパラメーターを使います。

パラメーター

filename: 取得するビデオファイルの名前 (hex64 エンコード)
op: stream

/api/holographic/mrc/file (DELETE)

デバイスから Mixed Reality の記録を削除します。

パラメーター

filename: 削除するファイルの名前 (hex64 エンコード)

/api/holographic/mrc/files (GET)

デバイスに格納されている Mixed Reality ファイルの一覧を返します。

/api/holographic/mrc/photo (POST)

Mixed Reality の写真を受け取り、デバイス上にファイルを作成します。

パラメーター

holo: ホログラムをキャプチャします: true または false (既定値は false)
pv: PV カメラをキャプチャします: true または false (既定値は false)
RenderFromCamera: (HoloLens 2 のみ) 写真またはビデオカメラの視点からレンダリングします: true または false (既定値は true)

/api/holographic/mrc/settings (GET)

既定の Mixed Reality キャプチャ設定を取得します。

/api/holographic/mrc/settings (POST)

既定の Mixed Reality キャプチャ設定を設定します。これらの設定の一部は、システムの MRC 写真とビデオキャプチャに適用されます。

/api/holographic/mrc/status (GET)

Windows デバイスポータル内の Mixed Reality キャプチャの状態を取得します。

Response

応答には、Windows デバイスポータルでビデオが録画中かどうかを示す JSON プロパティが含まれています。

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

指定したファイルのサムネイル画像を取得します。

パラメーター

filename: サムネイルが要求されているファイルの名前 (hex64 エンコード)

/api/holographic/mrc/video/control/start (POST)

Mixed Reality の記録を開始します。

パラメーター

holo: ホログラムをキャプチャします: true または false (既定値は false)
pv: PV カメラをキャプチャします: true または false (既定値は false)
mic: マイクをキャプチャします: true または false (既定値は false)
loopback: アプリの音声をキャプチャします: true または false (既定値は false)
RenderFromCamera: (HoloLens 2 のみ) 写真またはビデオカメラの視点からレンダリングします: true または false (既定値は true)
vstab: (HoloLens 2 のみ) ビデオ手ぶれ補正を有効にします: true または false (既定値は true)
vstabbuffer: (HoloLens 2 のみ) ビデオ手ぶれ補正バッファーの待機時間: 0 から 30 フレーム (既定値は 15 フレーム)

/api/holographic/mrc/video/control/stop (POST)

現在の Mixed Reality の録画を停止します。

Mixed Reality のストリーミング

注意事項

ループバックの分離のため、デバイス上のアプリ内から Mixed Reality のストリーミングに接続することはできません。

HoloLens は、フラグメント化された mp4 のチャンクダウンロードによる Mixed Reality のライブプレビューをサポートしています。

Mixed Reality のストリームにより、キャプチャされる対象を制御する同じパラメーターセットが共有されています。

holo: ホログラムをキャプチャします: true または false
pv: PV カメラをキャプチャします: true または false
マイク: マイクをキャプチャします: true または false
loopback: アプリの音声をキャプチャします: true または false

これらのいずれも指定されていない場合は、ホログラム、写真およびビデオカメラ、アプリの音声がキャプチャされます。

いずれかが指定されている場合、指定されていないパラメーターは既定で false になります。

省略可能なパラメーター (HoloLens 2 のみ)

RenderFromCamera: 写真またはビデオカメラの視点からレンダリングします: true または false (既定値は true)
vstab: ビデオ手ぶれ補正を有効にします: true または false (既定値は true)
vstabbuffer: ビデオ手ぶれ補正バッファーの待機時間: 0 から 30 フレーム (既定値は 15 フレーム)

/api/holographic/stream/live.mp4 (GET)

1280 x 720 p 30 fps 5 Mbit ストリーム。

/api/holographic/stream/live_high.mp4 (GET)

1280 x 720 p 30 fps 5 Mbit ストリーム。

/api/holographic/stream/live_med.mp4 (GET)

854 x 480 p 30 fps 2.5 Mbit ストリーム。

/api/holographic/stream/live_low.mp4 (GET)

428 x 240 p 15 fps 0.6 Mbit ストリーム。

ネットワーク

/api/networking/ipconfig (GET)

現在の IP 構成を取得します。

OS 情報

/api/os/info (GET)

オペレーティングシステムの情報を取得します。

/api/os/machinename (GET)

コンピューター名を取得します。

/api/os/machinename (POST)

コンピューター名を設定します。

パラメーター

name: 設定する新しいコンピューター名 (hex64 エンコード)

認識シミュレーションコントロール

/api/holographic/simulation/control/mode (GET)

シミュレーションモードを取得します。

/api/holographic/simulation/control/mode (POST)

シミュレーションモードを設定します。

パラメーター

mode: シミュレーションモード: default、simulation、remote、legacy

/api/holographic/simulation/control/stream (DELETE)

制御ストリームを削除します。

/api/holographic/simulation/control/stream (GET/WebSocket)

コントロールストリームの WebSocket 接続を開きます。

/api/holographic/simulation/control/stream (POST)

コントロールストリームを作成するか (優先順位が必要)、作成したストリームにデータをポストします (streamId が必要)。ポストされるデータの種類は 'application/octet-stream' と想定されます。

/api/holographic/simulation/display/stream (GET/WebSocket)

[シミュレーション] モードのときにシステムディスプレイにレンダリングされるコンテンツを含むシミュレーションビデオストリームを要求します。最初にシンプルなフォーマット記述子ヘッダーが送信され、次に H.264 でエンコードされたテクスチャが送信されます。それぞれの前には、目のインデックスとテクスチャサイズを示すヘッダーがあります。

認識シミュレーションの再生

/api/holographic/simulation/playback/file (DELETE)

記録を削除します。

パラメーター

recording: 削除する記録の名前。

/api/holographic/simulation/playback/file (POST)

記録をアップロードします。

/api/holographic/simulation/playback/files (GET)

すべての記録を取得します。

/api/holographic/simulation/playback/session (GET)

記録の現在の再生状態を取得します。

パラメーター

recording: 記録の名前。

/api/holographic/simulation/playback/session/file (DELETE)

記録をアンロードします。

パラメーター

recording: アンロードする記録の名前。

/api/holographic/simulation/playback/session/file (POST)

記録を読み込みます。

パラメーター

recording: 読み込む記録の名前。

/api/holographic/simulation/playback/session/files (GET)

読み込まれたすべての記録を取得します。

/api/holographic/simulation/playback/session/pause (POST)

記録を一時停止します。

パラメーター

recording: 記録の名前。

/api/holographic/simulation/playback/session/play (POST)

記録を再生します。

パラメーター

recording: 記録の名前。

/api/holographic/simulation/playback/session/stop (POST)

記録を停止します。

パラメーター

recording: 記録の名前。

/api/holographic/simulation/playback/session/types (GET)

読み込まれた記録内のデータの種類を取得します。

パラメーター

recording: 記録の名前。

認識シミュレーションの記録

/api/holographic/simulation/recording/start (POST)

記録を開始します。一度にアクティブにできる記録は 1 つだけです。 head、hands、spatialMapping、environment のいずれかを設定する必要があります。

パラメーター

head: 1 に設定すると、頭のデータが記録されます。
hands: 1 に設定すると、手のデータが記録されます。
spatialMapping: 1 に設定すると、空間マッピングが記録されます。
environment: 1 に設定すると、環境データが記録されます。
name: 記録の名前。
singleSpatialMappingFrame: 1 に設定すると、1 つの空間マッピングフレームだけが記録されます。

/api/holographic/simulation/recording/status (GET)

記録状態を取得します。

/api/holographic/simulation/recording/stop (GET)

現在の記録を停止します。記録はファイルとして返されます。

パフォーマンスデータ

/api/resourcemanager/processes (GET)

実行中のプロセスの一覧と詳細を返します。

データを返します

プロセスの一覧と各プロセスの詳細を含む JSON

/api/resourcemanager/systemperf (GET)

システムパフォーマンスの統計情報 (I/O 読み取り/書き込み、メモリの統計情報など) を返します。

データを返します

システム情報 (CPU、GPU、メモリ、ネットワーク、IO) を含む JSON

Power

/api/power/battery (GET)

現在のバッテリ状態を取得します。

/api/power/state (GET)

システムが低電力状態かどうかを確認します。

リモートコントロール

/api/control/restart (POST)

ターゲットデバイスを再起動します。

/api/control/shutdown (POST)

ターゲットデバイスをシャットダウンします。

タスクマネージャー

/api/taskmanager/app (DELETE)

モダンアプリを停止します。

パラメーター

package: アプリパッケージの完全名 (hex64 エンコード)
forcestop: すべてのプロセスを強制的に停止します (=yes)

/api/taskmanager/app (POST)

モダンアプリを開始します

パラメーター

appid: 開始するアプリの PRAID (hex64 エンコード)
package: アプリパッケージの完全名 (hex64 エンコード)

WiFi 管理

/api/wifi/interfaces (GET)

ワイヤレスネットワークインターフェイスを列挙します。

データを返します

ワイヤレスインターフェイスの一覧と詳細 (GUID、説明など)

/api/wifi/network (DELETE)

指定したインターフェイス上のネットワークに関連付けられているプロファイルを削除します。

パラメーター

interface: ネットワークインターフェイス GUID
profile: プロファイル名

/api/wifi/networks (GET)

指定したネットワークインターフェイス上のワイヤレスネットワークを列挙します。

パラメーター

interface: ネットワークインターフェイス GUID

データを返します

ネットワークインターフェイス上で見つかったワイヤレスネットワークの一覧と詳細

/api/wifi/network (POST)

指定したインターフェイス上のネットワークに接続または切断します。

パラメーター

interface: ネットワークインターフェイス GUID
ssid: 接続先の ssid (hex64 エンコード)
op: connect または disconnect
createprofile: yes または no
key: 共有キー (hex64 エンコード)

Windows パフォーマンスレコーダー

/api/wpr/customtrace (POST)

WPR プロファイルをアップロードし、アップロードしたプロファイルを使ってトレースを開始します。

ペイロード

マルチパート準拠の http 本文

データを返します

WPR セッションの状態を返します。

/api/wpr/status (GET)

WPR セッションの状態を取得します

データを返します

WPR セッションの状態。

/api/wpr/trace (GET)

WPR (パフォーマンス) トレースセッションを停止します。

データを返します

トレース ETL ファイルを返します。

/api/wpr/trace (POST)

WPR (パフォーマンス) トレースセッションを開始します。

パラメーター

profile: プロファイル名。指定できるプロファイルは、perfprofiles/profiles.json に格納されています。

データを返します

開始時に、WPR セッションの状態を返します。

次の方法で共有

Device Portal API リファレンス

アプリの展開

ダンプの収集

ETW

ホログラフィック OS

ホログラフィックの認識

ホログラフィックの温度

Map Manager

ファイルのダウンロード、アップロード、削除

エクスポート

[インポート]

その他

Mixed Reality キャプチャ

Mixed Reality のストリーミング

ネットワーク

OS 情報

認識シミュレーションコントロール

認識シミュレーションの再生

認識シミュレーションの記録

パフォーマンスデータ

Power

リモートコントロール

タスクマネージャー

WiFi 管理

Windows パフォーマンスレコーダー

関連項目

その他のリソース

次の方法で共有

Device Portal API リファレンス

アプリの展開

ダンプの収集

ETW

ホログラフィック OS

ホログラフィックの認識

ホログラフィックの温度

Map Manager

ファイルのダウンロード、アップロード、削除

エクスポート

[インポート]

その他

Mixed Reality キャプチャ

Mixed Reality のストリーミング

ネットワーク

OS 情報

認識シミュレーション コントロール

認識シミュレーションの再生

認識シミュレーションの記録

パフォーマンス データ

Power

リモート コントロール

タスク マネージャー

WiFi 管理

Windows パフォーマンス レコーダー

関連項目

その他のリソース

認識シミュレーションコントロール

パフォーマンスデータ

リモートコントロール

タスクマネージャー

Windows パフォーマンスレコーダー