デバイスポータル API リファレンス

[アーティクル]
02/18/2025

Windows デバイスポータルのすべての機能は、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 イベント

Holographic 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 要件を設定します。

パラメーター

必須: はい、いいえ、または既定値

Holographic Perception

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

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

パラメーター

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

Holographic Thermal

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

/api/holographic/thermal/stage (GET)

デバイスの温度ステージ (0 標準、1 ウォーム、2 クリティカル) を取得します。

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

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

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

オブジェクトの名前は周辺機器名で指定されます (例: Battery)

/api/holographic/thermal/setMitigationLevel (POST)

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

パラメーター

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

/api/holographic/thermal/setThermalScore (POST)

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

パラメーター

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

マップマネージャー

/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: 使用する空間マッピング DB の名前。

例:

$.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 キャプチャの状態を取得します。

応答

応答には、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)
マイク: マイクのキャプチャ: true または false (既定値は false)
ループバック: アプリオーディオのキャプチャ: 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
ループバック: アプリのオーディオをキャプチャする: true または false

これらのいずれかが指定されていない場合は、ホログラム、写真/ビデオカメラ、アプリオーディオがキャプチャされます。

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

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

RenderFromCamera: 写真/ビデオカメラの観点からレンダリングする: true または false (既定値は true)
vstab: ビデオの安定化を有効にする: true または false (既定値は false)
vstabbuffer: ビデオ安定化バッファー待機時間: 0 ~ 30 フレーム (既定値は 15 フレーム)

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

1280x720p 30fps 5Mbit ストリーム。

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

1280x720p 30fps 5Mbit ストリーム。

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

854x480p 30fps 2.5Mbit ストリーム。

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

428x240p 15fps 0.6Mbit ストリーム。

ネットワーク

/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: シミュレーションモード: 既定, シミュレーション, リモート, レガシ

/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 つだけです。ヘッド、ハンド、spatialMapping、環境のいずれかを設定する必要があります。

パラメーター

head: ヘッドデータを記録するには、1 に設定します。
hand: 手のデータを記録するには、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)

システム perf 統計 (I/O の読み取り/書き込み、メモリ統計など) を返します。

データを返す

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

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(164 エンコード)
package: アプリパッケージの完全な名前 (hex64 エンコード)

WiFi 管理

/api/wifi/interfaces (GET)

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

データを返す

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

/api/wifi/network (DELETE)

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

パラメーター

interface: ネットワークインターフェイス guid
profile: profile name

/api/wifi/networks (GET)

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

パラメーター

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

データを返す

ネットワークインターフェイスで検出されたワイヤレスネットワークの一覧と詳細

/api/wifi/network (POST)

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

パラメーター

interface: ネットワークインターフェイス guid
ssid: ssid,hex64 encoded, to connect to connect to
op: 接続または切断
createprofile: はいまたはいいえ
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 セッションの状態を返します。

次の方法で共有

デバイスポータル API リファレンス

アプリの展開

ダンプコレクション

ETW

Holographic OS

Holographic Perception

Holographic Thermal

マップマネージャー

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

エクスポート

インポート

その他

Mixed Reality キャプチャ

Mixed Reality ストリーミング

ネットワーク

OS 情報

知覚シミュレーション制御

知覚シミュレーション再生

知覚シミュレーションの記録

パフォーマンスデータ

Power

リモート制御

タスクマネージャー

WiFi 管理

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

関連項目

フィードバック

その他のリソース

次の方法で共有

デバイス ポータル API リファレンス

アプリの展開

ダンプ コレクション

ETW

Holographic OS

Holographic Perception

Holographic Thermal

マップ マネージャー

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

エクスポート

インポート

その他

Mixed Reality キャプチャ

Mixed Reality ストリーミング

ネットワーク

OS 情報

知覚シミュレーション制御

知覚シミュレーション再生

知覚シミュレーションの記録

パフォーマンス データ

Power

リモート制御

タスク マネージャー

WiFi 管理

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

関連項目

フィードバック

その他のリソース

デバイスポータル API リファレンス

ダンプコレクション

マップマネージャー

パフォーマンスデータ

タスクマネージャー

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