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

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

アプリの撮るApp deloyment

/api/app/packagemanager/package (削除)/api/app/packagemanager/package (DELETE)

アプリをアンインストールしますUninstalls an app

パラメーターParameters

  • パックアンインストールするパッケージのファイル名。package : File name of the package to be uninstalled.

/api/app/packagemanager/package (POST)/api/app/packagemanager/package (POST)

アプリをインストールしますInstalls an App

パラメーターParameters

  • パックインストールするパッケージのファイル名。package : File name of the package to be installed.

ペイロードPayload

  • マルチパート準拠の http 本文multi-part conforming http body

/api/app/packagemanager/packages (GET)/api/app/packagemanager/packages (GET)

システムにインストールされているアプリの一覧を詳細と共に取得します。Retrieves the list of installed apps on the system, with details

データを返すReturn data

  • インストールされているパッケージの一覧と詳細List of installed packages with details

/api/app/packagemanager/state (GET)/api/app/packagemanager/state (GET)

進行中のアプリのインストールの状態を取得しますGets the status of in progress app installation

ダンプの収集Dump collection

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

サイドロードアプリのクラッシュダンプの収集を無効にします。Disables crash dump collection for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

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

サイドロード apps のクラッシュダンプの収集の設定を取得します。Gets settings for sideloaded apps crash dump collection

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

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

サイドロードアプリのダンプ制御設定を有効にして設定しますEnables and sets dump control settings for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name

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

サイドロードアプリのクラッシュダンプを削除します。Deletes a crash dump for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name
  • fileName: ダンプファイル名fileName : dump file name

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

サイドロードアプリのクラッシュダンプを取得します。Retrieves a crash dump for a sideloaded app

パラメーターParameters

  • packageFullname: パッケージ名packageFullname : package name
  • fileName: ダンプファイル名fileName : dump file name

データを返すReturn data

  • ダンプファイル。Dump file. WinDbg または Visual Studio を使用して検査するInspect with WinDbg or Visual Studio

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

サイドロードアプリのすべてのクラッシュダンプの一覧を返します。Returns list of all crash dumps for sideloaded apps

データを返すReturn data

  • サイドロードされたアプリごとのクラッシュダンプの一覧List of crash dumps per side loaded app

ETWETW

/api/etw/providers (GET)/api/etw/providers (GET)

登録されたプロバイダーを列挙しますEnumerates registered providers

データを返すReturn data

  • プロバイダー、フレンドリ名、GUID の一覧List of providers, friendly name and GUID

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

リアルタイム ETW セッションを作成します。websocket 経由で管理されます。Creates a realtime ETW session; managed over a websocket.

データを返すReturn data

  • 有効なプロバイダーからの ETW イベントETW events from the enabled providers

ホログラフィック OSHolographic OS

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

システムに登録されていない HoloLens 固有の ETW プロバイダーの一覧を返します。Returns a list of HoloLens specific ETW providers that are not registered with the system

/api/holographic/os/services (GET)/api/holographic/os/services (GET)

実行中のすべてのサービスの状態を返します。Returns the states of all services running.

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

格納されている IPD (Interpupillary distance) をミリメートル単位で取得します。Gets the stored IPD (Interpupillary distance) in millimeters

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

IPD を設定します。Sets the IPD

パラメーターParameters

  • ipdミリメートル単位で設定する新しい IPD 値ipd : New IPD value to be set in millimeters

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

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

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

デバイスポータルの HTTPS 要件を設定します。Sets HTTPS requirements for the Device Portal

パラメーターParameters

  • 必須: はい、いいえ、または既定値required : yes, no or default

Holographic の認識Holographic Perception

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

Websocket のアップグレードを受け入れ、30 fps で更新を送信する認識クライアントを実行します。Accepts websocket upgrades and runs a perception client that sends updates at 30 fps.

パラメーターParameters

  • clientmode: "active" は、受動的に確立できないときにビジュアル追跡モードを強制します。clientmode: "active" forces visual tracking mode when it can't be established passively

Holographic ThermalHolographic Thermal

/api/holographic/thermal/stage (GET)/api/holographic/thermal/stage (GET)

デバイスの温度ステージを取得する (通常は0、1ウォーム、2重大)Get the thermal stage of the device (0 normal, 1 warm, 2 critical)

認識シミュレーションの制御Perception Simulation Control

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

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

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

シミュレーションモードの設定Set the simulation mode

パラメーターParameters

  • モード: シミュレーションモード: 既定、シミュレーション、リモート、レガシmode : simulation mode: default, simulation, remote, legacy

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

コントロールストリームを削除します。Delete a control stream.

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

コントロールストリームの web ソケット接続を開きます。Open a web socket connection for a control stream.

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

コントロールストリームを作成するか (優先順位が必要)、作成されたストリームにデータを post します (streamId が必要)。Create a control stream (priority is required) or post data to a created stream (streamId required). ポストされたデータは ' application/オクテット-stream ' 型である必要があります。Posted data is expected to be of type 'application/octet-stream'.

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

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

記録を削除します。Delete a recording.

パラメーターParameters

  • 録音削除する記録の名前。recording : Name of recording to delete.

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

記録をアップロードします。Upload a recording.

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

すべての記録を取得します。Get all recordings.

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

記録の現在の再生状態を取得します。Get the current playback state of a recording.

パラメーターParameters

  • 録音記録の名前。recording : Name of recording.

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

記録をアンロードします。Unload a recording.

パラメーターParameters

  • 録音アンロードする記録の名前。recording : Name of recording to unload.

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

記録を読み込みます。Load a recording.

パラメーターParameters

  • 録音読み込む記録の名前。recording : Name of recording to load.

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

読み込まれたすべての録音を取得します。Get all loaded recordings.

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

記録を一時停止します。Pause a recording.

パラメーターParameters

  • 録音記録の名前。recording : Name of recording.

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

録音を再生します。Play a recording.

パラメーターParameters

  • 録音記録の名前。recording : Name of recording.

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

記録を停止します。Stop a recording.

パラメーターParameters

  • 録音記録の名前。recording : Name of recording.

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

読み込まれた記録のデータの種類を取得します。Get the types of data in a loaded recording.

パラメーターParameters

  • 録音記録の名前。recording : Name of recording.

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

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

記録を開始します。Start a recording. 一度にアクティブにできる記録は1つだけです。Only a single recording can be active at once. ヘッド、ハンド、spatialMapping、または環境のいずれかを設定する必要があります。One of head, hands, spatialMapping or environment must be set.

パラメーターParameters

  • 矢印ヘッドデータを記録するには、を1に設定します。head : Set to 1 to record head data.
  • みるハンドデータを記録するには、を1に設定します。hands : Set to 1 to record hand data.
  • spatialMapping :空間マッピングを記録するには、1に設定します。spatialMapping : Set to 1 to record spatial mapping.
  • environment環境データを記録するには、を1に設定します。environment : Set to 1 to record environment data.
  • 指定記録の名前。name : Name of the recording.
  • singleSpatialMappingFrame :1に設定すると、空間マッピングフレームが1つだけ記録されます。singleSpatialMappingFrame : Set to 1 to record only a single spatial mapping frame.

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

記録の状態を取得します。Get recording state.

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

現在の記録を停止します。Stop the current recording. 記録はファイルとして返されます。Recording will be returned as a file.

Mixed Reality キャプチャMixed Reality Capture

/api/holographic/mrc/file (GET)/api/holographic/mrc/file (GET)

混合の現実ファイルをデバイスからダウンロードします。Downloads a mixed reality file from the device. ストリーミングには op = stream クエリパラメーターを使用します。Use op=stream query parameter for streaming.

パラメーターParameters

  • /db取得するビデオファイルの名前 (hex64 encoded)filename : Name, hex64 encoded, of the video file to get
  • op: ストリームop : stream

/api/holographic/mrc/file (削除)/api/holographic/mrc/file (DELETE)

デバイスから mixed reality の記録を削除します。Deletes a mixed reality recording from the device.

パラメーターParameters

  • /db削除するファイルの名前、hex64 encodedfilename : Name, hex64 encoded, of the file to delete

/api/holographic/mrc/files (GET)/api/holographic/mrc/files (GET)

デバイスに格納されている mixed reality ファイルの一覧を返します。Returns the list of mixed reality files stored on the device

/api/holographic/mrc/photo (POST)/api/holographic/mrc/photo (POST)

Mixed reality の写真を取得し、デバイスにファイルを作成します。Takes a mixed reality photo and creates a file on the device

パラメーターParameters

  • holo: キャプチャホログラム: true または false (既定値は false)holo : capture holograms: true or false (defaults to false)
  • pv: キャプチャの PV カメラ: true または false (既定値は false)pv : capture PV camera: true or false (defaults to false)
  • RenderFromCamera:(HoloLens 2 のみ) 写真/ビデオカメラの視点からレンダー: true または false (既定値は true)RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)

/api/holographic/mrc/settings (GET)/api/holographic/mrc/settings (GET)

既定の mixed reality キャプチャ設定を取得します。Gets the default mixed reality capture settings

/api/holographic/mrc/settings (POST)/api/holographic/mrc/settings (POST)

既定の mixed reality キャプチャ設定を設定します。Sets the default mixed reality capture settings. これらの設定の一部は、システムの MRC の写真とビデオキャプチャに適用されます。Some of these settings are applied to the system's MRC photo and video capture.

/api/holographic/mrc/status (GET)/api/holographic/mrc/status (GET)

記録された mixed reality の状態を取得します (実行中、停止済み)Gets the status of the mixed reality recorded (running, stopped)

/api/holographic/mrc/thumbnail (GET)/api/holographic/mrc/thumbnail (GET)

指定したファイルのサムネイルイメージを取得します。Gets the thumbnail image for the specified file.

パラメーターParameters

  • /dbサムネイルが要求されているファイルの名前、hex64 encodedfilename: Name, hex64 encoded, of the file for which the thumbnail is being requested

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

Mixed reality の記録を開始しますStarts a mixed reality recording

パラメーターParameters

  • holo: キャプチャホログラム: true または false (既定値は false)holo : capture holograms: true or false (defaults to false)
  • pv: キャプチャの PV カメラ: true または false (既定値は false)pv : capture PV camera: true or false (defaults to false)
  • mic: キャプチャマイク: true または false (既定値は false)mic : capture microphone: true or false (defaults to false)
  • ループバック: キャプチャアプリオーディオ: true または false (既定値は false)loopback : capture app audio: true or false (defaults to false)
  • RenderFromCamera:(HoloLens 2 のみ) 写真/ビデオカメラの視点からレンダー: true または false (既定値は true)RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)
  • vstab :(HoloLens 2 のみ) ビデオ安定化を有効にします (true または false) (既定値は true)vstab : (HoloLens 2 only) enable video stabilization: true or false (defaults to true)
  • vstabbuffer:(HoloLens 2 のみ) ビデオ安定化バッファー待機時間:0 ~ 30 フレーム (既定値は15フレーム)vstabbuffer: (HoloLens 2 only) video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

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

現在の mixed reality 記録を停止しますStops the current mixed reality recording

Mixed Reality ストリーミングMixed Reality Streaming

HoloLens は、フラグメント化された mp4 のチャンクダウンロードを使用して、混合現実のライブプレビューをサポートします。HoloLens supports live preview of mixed reality via chunked download of a fragmented mp4.

混合現実のストリームは、キャプチャ対象を制御するために、同じパラメーターのセットを共有します。Mixed reality streams share the same set of parameters to control what is captured:

  • holo: キャプチャホログラム: true または falseholo : capture holograms: true or false
  • pv: キャプチャの PV カメラ: true または falsepv : capture PV camera: true or false
  • mic: マイクのキャプチャ: true または falsemic : capture microphone: true or false
  • ループバック: アプリオーディオのキャプチャ: true または falseloopback : capture app audio: true or false

これらのいずれも指定されていない場合、ホログラム、photo/video カメラ、アプリオーディオがキャプチャされます。If none of these are specified: holograms, photo/video camera, and app audio will be captured
指定されている場合: 未指定のパラメーターは既定で false に設定されます。If any are specified: the unspecified parameters will default to false

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

  • RenderFromCamera: 写真/ビデオカメラから見たレンダリング: true または false (既定値は true)RenderFromCamera : render from perspective of photo/video camera: true or false (defaults to true)
  • vstab: ビデオ安定化を有効にします。 true または false (既定値は false)vstab : enable video stabilization: true or false (defaults to false)
  • vstabbuffer: ビデオ安定化バッファーの待機時間:0 ~ 30 フレーム (既定値は15フレーム)vstabbuffer: video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

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

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

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

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

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

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

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

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

ネットワークNetworking

/api/networking/ipconfig (GET)/api/networking/ipconfig (GET)

現在の ip 構成を取得します。Gets the current ip configuration

OS 情報OS Information

/api/info (GET)/api/os/info (GET)

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

/api/machinename (GET)/api/os/machinename (GET)

コンピューター名を取得します。Gets the machine name

/api/machinename (POST)/api/os/machinename (POST)

コンピューター名を設定しますSets the machine name

パラメーターParameters

  • 指定に設定する新しいコンピューター名 (hex64 encoded)name : New machine name, hex64 encoded, to set to

パフォーマンス データPerformance data

/api/resourcemanager/processes (GET)/api/resourcemanager/processes (GET)

詳細を含む実行中のプロセスの一覧を返しますReturns the list of running processes with details

データを返すReturn data

  • 各プロセスのプロセスと詳細の一覧を含む JSONJSON with list of processes and details for each process

/api/resourcemanager/systemperf (GET)/api/resourcemanager/systemperf (GET)

システムパフォーマンス統計情報 (i/o 読み取り/書き込み、メモリ統計など) を返します。Returns system perf statistics (I/O read/write, memory stats etc.

データを返すReturn data

  • システム情報を含む JSON:CPU、GPU、メモリ、ネットワーク、IOJSON with system information: CPU, GPU, Memory, Network, IO

PowerPower

/api/バッテリ (GET)/api/power/battery (GET)

現在のバッテリの状態を取得します。Gets the current battery state

//(GET)/api/power/state (GET)

システムが低電力状態であるかどうかを確認しますChecks if the system is in a low power state

リモート コントロールRemote Control

/api/control/restart (POST)/api/control/restart (POST)

ターゲットデバイスを再起動しますRestarts the target device

/api/control/shutdown (POST)/api/control/shutdown (POST)

ターゲットデバイスをシャットダウンしますShuts down the target device

タスク マネージャーTask Manager

/api/taskmanager/app (削除)/api/taskmanager/app (DELETE)

モダンアプリを停止しますStops a modern app

パラメーターParameters

  • パックアプリケーションパッケージの完全名、hex64 encodedpackage : Full name of the app package, hex64 encoded
  • forcestop:すべてのプロセスを強制的に停止する (= yes)forcestop : Force all processes to stop (=yes)

/api/taskmanager/app (POST)/api/taskmanager/app (POST)

モダンアプリを開始しますStarts a modern app

パラメーターParameters

  • appidアプリの開始、hex64 エンコードappid : PRAID of app to start, hex64 encoded
  • パックアプリケーションパッケージの完全名、hex64 encodedpackage : Full name of the app package, hex64 encoded

WiFi の管理WiFi Management

/api/wifi/interfaces (GET)/api/wifi/interfaces (GET)

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

データを返すReturn data

  • 詳細 (GUID、説明など) があるワイヤレスインターフェイスの一覧List of wireless interfaces with details (GUID, description etc.)

/api/wifi/network (削除)/api/wifi/network (DELETE)

指定したインターフェイスのネットワークに関連付けられているプロファイルを削除します。Deletes a profile associated with a network on a specified interface

パラメーターParameters

  • インターフェイス: ネットワークインターフェイス guidinterface : network interface guid
  • プロファイル: プロファイル名profile : profile name

/api/wifi/networks (GET)/api/wifi/networks (GET)

指定されたネットワークインターフェイスのワイヤレスネットワークを列挙しますEnumerates wireless networks on the specified network interface

パラメーターParameters

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

データを返すReturn data

  • ネットワークインターフェイスで検出されたワイヤレスネットワークの一覧と詳細List of wireless networks found on the network interface with details

/api/wifi/network (POST)/api/wifi/network (POST)

指定されたインターフェイスでネットワークに接続または切断します。Connects or disconnects to a network on the specified interface

パラメーターParameters

  • インターフェイス: ネットワークインターフェイス guidinterface : network interface guid
  • ssid: 接続先の ssid、hex64 encoded、ssid : ssid, hex64 encoded, to connect to
  • op: 接続または切断op : connect or disconnect
  • createprofile: はいまたはいいえcreateprofile : yes or no
  • キー: shared key、hex64 encodedkey : shared key, hex64 encoded

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

/api/wpr/customtrace (POST)/api/wpr/customtrace (POST)

WPR プロファイルをアップロードし、アップロードされたプロファイルを使用してトレースを開始します。Uploads a WPR profile and starts tracing using the uploaded profile.

ペイロードPayload

  • マルチパート準拠の http 本文multi-part conforming http body

データを返すReturn data

  • WPR セッションの状態を返します。Returns the WPR session status.

/api/wpr/status (GET)/api/wpr/status (GET)

WPR セッションの状態を取得します。Retrieves the status of the WPR session

データを返すReturn data

  • WPR セッションの状態。WPR session status.

/api/wpr/trace (GET)/api/wpr/trace (GET)

WPR (パフォーマンス) トレースセッションを停止しますStops a WPR (performance) tracing session

データを返すReturn data

  • トレース ETL ファイルを返します。Returns the trace ETL file

/api/wpr/trace (POST)/api/wpr/trace (POST)

WPR (パフォーマンス) トレースセッションを開始しますStarts a WPR (performance) tracing sessions

パラメーターParameters

  • profileプロファイル名。profile : Profile name. 使用可能なプロファイルは perfprofiles/profiles. json に格納されます。Available profiles are stored in perfprofiles/profiles.json

データを返すReturn data

  • 開始時に、WPR セッションの状態を返します。On start, returns the WPR session status.

関連項目See also