Bagikan melalui

Referensi API portal perangkat

  • Artikel

Semua yang ada di Portal Perangkat Windows dibangun di atas REST API yang dapat Anda gunakan untuk mengakses data dan mengontrol perangkat Anda secara terprogram.

Penyebaran aplikasi

/api/app/packagemanager/package (DELETE)

Menghapus instalan aplikasi.

Parameter

  • paket: Nama file paket yang akan dihapus instalasinya.

/api/app/packagemanager/package (POST)

Menginstal Aplikasi.

Parameter

  • paket: Nama file paket yang akan diinstal.

Payload

  • multi-bagian sesuai dengan isi http

/api/app/packagemanager/packages (GET)

Mengambil daftar aplikasi yang diinstal pada sistem. Termasuk detailnya.

Mengembalikan data

  • Daftar paket yang diinstal dengan detail

/api/app/packagemanager/state (GET)

Mendapatkan status penginstalan aplikasi yang sedang berlangsung.

Koleksi cadangan

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

Menonaktifkan pengumpulan crash dump untuk aplikasi yang dimuat samping.

Parameter

  • packageFullName: nama paket

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

Mendapatkan pengaturan untuk koleksi crash dump aplikasi yang dimuat samping.

Parameter

  • packageFullName: nama paket

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

Mengaktifkan dan mengatur pengaturan kontrol cadangan untuk aplikasi yang dimuat samping.

Parameter

  • packageFullName: nama paket

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

Menghapus crash dump untuk aplikasi yang dimuat samping.

Parameter

  • packageFullName: nama paket
  • fileName: nama file cadangan

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

Mengambil crash dump untuk aplikasi yang dimuat samping.

Parameter

  • packageFullName: nama paket
  • fileName: nama file cadangan

Mengembalikan data

  • File cadangan. Periksa dengan WinDbg atau Visual Studio.

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

Mengembalikan daftar semua crash dump untuk aplikasi yang dimuat samping.

Mengembalikan data

  • Daftar crash dump per aplikasi yang dimuat di sisi

ETW

/api/etw/providers (GET)

Menghitung penyedia terdaftar.

Mengembalikan data

  • Daftar penyedia, nama yang mudah diingat, dan GUID

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

Membuat sesi ETW real time; dikelola melalui websocket.

Mengembalikan data

  • Peristiwa ETW dari penyedia yang diaktifkan

OS Holografik

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

Mengembalikan daftar penyedia ETW khusus HoloLens yang tidak terdaftar di sistem.

/api/holographic/os/services (GET)

Mengembalikan status semua layanan yang berjalan.

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

Mendapatkan IPD tersimpan (jarak Interpupillary) dalam milimeter.

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

Mengatur IPD.

Parameter

  • ipd: Nilai IPD baru yang akan ditetapkan dalam milimeter

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

Mendapatkan persyaratan HTTPS untuk Portal Perangkat.

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

Menetapkan persyaratan HTTPS untuk Portal Perangkat.

Parameter

  • diperlukan: ya, tidak atau default

Persepsi Holografik

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

Menerima peningkatan WebSocket dan menjalankan klien persepsi yang mengirim pembaruan pada 30 fps.

Parameter

  • clientmode: "active" memaksa mode pelacakan visual ketika tidak dapat ditetapkan secara pasif

Termal Holografik

Saat menggunakan API termal ini, referensikan artikel mengelola daya dan termal .

/api/holographic/thermal/stage (GET)

Dapatkan tahap termal perangkat (0 normal, 1 hangat, 2 kritis).

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

Buka websocket (atau lakukan satu kueri HTTP GET), mengembalikan daftar objek yang berisi berikut ini:

  • IsSuppressed - Mengidentifikasi apakah periferal tertentu memiliki mitigasi yang ditekan
  • Level - Tingkat mitigasi termal terbaru untuk periferal ini
  • Masker - Masker periferal ini
  • ThermalScore - Skor termal terbaru untuk periferal ini

Objek dinamai dengan nama periferal (Contoh: Baterai)

/api/holographic/thermal/setMitigationLevel (POST)

Mengubah tingkat mitigasi yang dilaporkan untuk periferal tertentu

Parameter

  • masker: bitmask dengan set bit tunggal untuk periferal yang menarik (Lihat PowerThermalPeripheralFlags untuk detailnya)
  • level: level baru yang akan digunakan (0-3)

/api/holographic/thermal/setThermalScore (POST)

Mengubah skor termal yang dilaporkan untuk periferal tertentu

Parameter

  • masker: bitmask dengan set bit tunggal untuk periferal yang menarik (Lihat PowerThermalPeripheralFlags untuk detailnya)
  • thermalScore: skor termal baru untuk digunakan (100-0)

Manajer Peta

/api/holographic/mapmanager/mapFiles (GET)

Mendapatkan daftar file peta yang tersedia (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Mendapatkan daftar file jangkar yang tersedia (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Mendapatkan daftar file database rekonstruksi spasial yang tersedia (.srdb).

/api/holographic/mapmanager/getanchors (GET)

Mendapatkan daftar jangkar yang bertahan untuk pengguna saat ini.

Unduh/Unggah/Hapus File

/api/holographic/mapmanager/download (GET)

Mengunduh file database peta, jangkar, atau rekonstruksi spasial. File harus telah diunggah atau diekspor sebelumnya.

Parameter

  • FileName: Nama file yang akan diunduh.

Contoh:

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

/api/holographic/mapmanager/upload (POST)

Mengunggah file database rekonstruksi peta, jangkar, atau spasial. Setelah file diunggah, file nantinya dapat diimpor dan digunakan oleh sistem.

Parameter

  • file: Nama file yang akan diunggah.

Contoh:

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)

Menghapus file database rekonstruksi peta, jangkar, atau spasial. File harus telah diunggah atau diekspor sebelumnya.

Parameter

  • FileName: Nama file yang akan dihapus.

Contoh:

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

Ekspor

/api/holographic/mapmanager/export (POST)

Mengekspor peta yang saat ini digunakan oleh sistem. Setelah diekspor, dapat diunduh.

Contoh:

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

/api/holographic/mapmanager/exportanchors (POST)

Mengekspor peta yang saat ini digunakan oleh sistem. Setelah diekspor, dapat diunduh. Contoh:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Mengekspor peta dan jangkar yang saat ini digunakan oleh sistem. Setelah diekspor, mereka dapat diunduh. Contoh:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Mengekspor peta dan database rekonstruksi spasial yang saat ini digunakan oleh sistem. Setelah diekspor, mereka dapat diunduh.

Contoh:

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

Impor

/api/holographic/mapmanager/import (POST)

Menunjukkan kepada sistem peta mana yang harus digunakan. Dapat dipanggil pada file yang telah diekspor atau diunggah.

Parameter

  • FileName: Nama peta yang akan digunakan.

Contoh:

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

/api/holographic/mapmanager/importanchors (POST)

Menunjukkan ke sistem jangkar mana yang harus digunakan. Dapat dipanggil pada file yang telah diekspor atau diunggah.

Parameter

  • FileName: Nama jangkar yang akan digunakan.

Contoh:

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

/api/holographic/mapmanager/importspatialmappingdb (POST)

Menunjukkan ke sistem database rekonstruksi spasial mana yang harus digunakan. Dapat dipanggil pada file yang telah diekspor atau diunggah.

Parameter

  • FileName: Nama db pemetaan spasial yang akan digunakan.

Contoh:

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

Lainnya

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Reset sistem peta, jangkar, dan database rekonstruksi spasial.

Contoh:

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

/api/holographic/mapmanager/status (GET)

Mendapatkan status sistem, termasuk file database peta, jangkar, dan rekonstruksi spasial mana yang terakhir diimpor.

Mixed Reality Capture

/api/holographic/mrc/file (GET)

Mengunduh file realitas campuran dari perangkat. Gunakan parameter kueri op=stream untuk streaming.

Parameter

  • filename: Name, hex64 encoded, dari file video yang akan didapatkan
  • op: stream

/api/holographic/mrc/file (DELETE)

Menghapus rekaman realitas campuran dari perangkat.

Parameter

  • filename: Name, hex64 encoded, dari file yang akan dihapus

/api/holographic/mrc/files (GET)

Mengembalikan daftar file realitas campuran yang disimpan di perangkat.

/api/holographic/mrc/photo (POST)

Mengambil foto realitas campuran dan membuat file di perangkat.

Parameter

  • holo: menangkap hologram: benar atau salah (default ke false)
  • pv: ambil kamera PV: true atau false (default ke false)
  • RenderFromCamera: (hanya HoloLens 2) dirender dari perspektif kamera foto/video: true atau false (default ke true)

/api/holographic/mrc/settings (GET)

Mendapatkan pengaturan pengambilan realitas campuran default.

/api/holographic/mrc/settings (POST)

Mengatur pengaturan pengambilan realitas campuran default. Beberapa pengaturan ini diterapkan ke pengambilan foto dan video MRC sistem.

/api/holographic/mrc/status (GET)

Mendapatkan status pengambilan realitas campuran dalam Portal Perangkat Windows.

Respons

Respons berisi properti JSON yang menunjukkan apakah Portal Perangkat Windows merekam video atau tidak.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Mendapatkan gambar mini untuk file yang ditentukan.

Parameter

  • filename: Name, hex64 encoded, dari file yang thumbnail-nya sedang diminta

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

Memulai rekaman realitas campuran.

Parameter

  • holo: menangkap hologram: benar atau salah (default ke false)
  • pv: ambil kamera PV: true atau false (default ke false)
  • mikrofon: menangkap mikrofon: benar atau salah (default ke false)
  • loopback: mengambil audio aplikasi: true atau false (default ke false)
  • RenderFromCamera: (hanya HoloLens 2) dirender dari perspektif kamera foto/video: true atau false (default ke true)
  • vstab: (hanya HoloLens 2) mengaktifkan stabilisasi video: true atau false (default ke true)
  • vstabbuffer: (hanya HoloLens 2) latensi buffer stabilisasi video: 0 hingga 30 bingkai (default ke 15 bingkai)

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

Menghentikan perekaman realitas campuran saat ini.

Streaming Mixed Reality

Perhatian

Karena isolasi loopback, Anda tidak dapat terhubung ke streaming realitas campuran dari dalam aplikasi di perangkat.

HoloLens mendukung pratinjau langsung realitas campuran melalui unduhan potongan mp4 terfragmentasi.

Aliran realitas campuran berbagi sekumpulan parameter yang sama untuk mengontrol apa yang diambil:

  • holo: menangkap hologram: benar atau salah
  • pv: ambil kamera PV: benar atau salah
  • mikrofon: menangkap mikrofon: benar atau salah
  • loopback: mengambil audio aplikasi: true atau false

Jika tidak ada yang ditentukan, maka hologram, kamera foto/video, dan audio aplikasi akan diambil.

Jika ada yang ditentukan, parameter yang tidak ditentukan akan default ke false

Parameter opsional (hanya HoloLens 2)

  • RenderFromCamera: render dari perspektif kamera foto/video: true atau false (default ke true)
  • vstab: aktifkan stabilisasi video: true atau false (default ke false)
  • vstabbuffer: latensi buffer stabilisasi video: 0 hingga 30 bingkai (default ke 15 bingkai)

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

Aliran 5Mbit 1280x720p 30fps.

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

Aliran 5Mbit 1280x720p 30fps.

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

Aliran 854x480p 30fps 2.5Mbit.

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

Aliran 428x240p 15fps 0.6Mbit.

Jaringan

/api/networking/ipconfig (GET)

Mendapatkan konfigurasi IP saat ini.

Informasi OS

/api/os/info (GET)

Mendapatkan informasi sistem operasi.

/api/os/machinename (GET)

Mendapatkan nama mesin.

/api/os/machinename (POST)

Mengatur nama komputer.

Parameter

  • nama: Nama komputer baru, dikodekan hex64, untuk diatur ke

Kontrol Simulasi Persepsi

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

Mendapatkan mode simulasi.

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

Mengatur mode simulasi.

Parameter

  • mode: mode simulasi: default, simulasi, jarak jauh, warisan

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

Menghapus aliran kontrol.

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

Buka koneksi WebSocket untuk aliran kontrol.

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

Buat aliran kontrol (prioritas diperlukan) atau posting data ke aliran yang dibuat (streamId diperlukan). Data yang diposting diharapkan berjenis 'application/octet-stream'.

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

Minta aliran video simulasi yang berisi konten yang dirender ke tampilan sistem saat dalam mode 'Simulasi'. Header deskriptor format sederhana akan dikirim pada awalnya, diikuti oleh tekstur yang dikodekan H.264, dengan masing-masing didahului oleh header yang menunjukkan indeks mata dan ukuran tekstur.

Pemutaran Simulasi Persepsi

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

Menghapus rekaman.

Parameter

  • rekaman: Nama rekaman yang akan dihapus.

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

Unggah rekaman.

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

Dapatkan semua rekaman.

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

Dapatkan status pemutaran rekaman saat ini.

Parameter

  • recording: Nama rekaman.

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

Membongkar rekaman.

Parameter

  • recording: Nama rekaman untuk dibongkar.

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

Muat rekaman.

Parameter

  • recording: Nama rekaman yang akan dimuat.

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

Dapatkan semua rekaman yang dimuat.

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

Menjeda rekaman.

Parameter

  • recording: Nama rekaman.

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

Putar rekaman.

Parameter

  • recording: Nama rekaman.

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

Hentikan rekaman.

Parameter

  • recording: Nama rekaman.

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

Dapatkan jenis data dalam rekaman yang dimuat.

Parameter

  • recording: Nama rekaman.

Perekaman Simulasi Persepsi

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

Mulai perekaman. Hanya satu rekaman yang dapat aktif sekaligus. Salah satunya harus diatur: kepala, tangan, spasialMapping atau lingkungan.

Parameter

  • head: Atur ke 1 untuk merekam data kepala.
  • tangan: Atur ke 1 untuk merekam data tangan.
  • spatialMapping: Atur ke 1 untuk merekam pemetaan spasial.
  • environment: Atur ke 1 untuk merekam data lingkungan.
  • nama: Nama rekaman.
  • singleSpatialMappingFrame: Atur ke 1 untuk merekam hanya satu bingkai pemetaan spasial.

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

Dapatkan status perekaman.

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

Hentikan perekaman saat ini. Rekaman akan dikembalikan sebagai file.

Data performa

/api/resourcemanager/processes (GET)

Mengembalikan daftar proses yang sedang berjalan dengan detail.

Mengembalikan data

  • JSON dengan daftar proses dan detail untuk setiap proses

/api/resourcemanager/systemperf (GET)

Mengembalikan statistik perf sistem (baca/tulis I/O, statistik memori, dll.

Mengembalikan data

  • JSON dengan informasi sistem: CPU, GPU, Memori, Jaringan, IO

Daya

/api/power/battery (GET)

Mendapatkan status baterai saat ini.

/api/power/state (GET)

Memeriksa apakah sistem dalam status daya rendah.

Remote Control

/api/control/restart (POST)

Memulai ulang perangkat target.

/api/control/shutdown (POST)

Mematikan perangkat target.

Pengelola Tugas

/api/taskmanager/app (DELETE)

Menghentikan aplikasi modern.

Parameter

  • paket: Nama lengkap paket aplikasi, dikodekan hex64
  • forcestop: Paksa semua proses untuk berhenti (=ya)

/api/taskmanager/app (POST)

Memulai aplikasi modern

Parameter

  • appid: PRAID aplikasi untuk memulai, dikodekan hex64
  • paket: Nama lengkap paket aplikasi, dikodekan hex64

Manajemen WiFi

/api/wifi/interfaces (GET)

Menghitung antarmuka jaringan nirkabel.

Mengembalikan data

  • Daftar antarmuka nirkabel dengan detail (GUID, deskripsi, dll.)

/api/wifi/network (DELETE)

Menghapus profil yang terkait dengan jaringan pada antarmuka tertentu.

Parameter

  • antarmuka: guid antarmuka jaringan
  • profil: nama profil

/api/wifi/networks (GET)

Menghitung jaringan nirkabel pada antarmuka jaringan yang ditentukan.

Parameter

  • antarmuka: guid antarmuka jaringan

Mengembalikan data

  • Daftar jaringan nirkabel yang ditemukan pada antarmuka jaringan dengan detail

/api/wifi/network (POST)

Menyambungkan atau memutuskan sambungan ke jaringan pada antarmuka yang ditentukan.

Parameter

  • antarmuka: guid antarmuka jaringan
  • ssid: ssid, hex64 encoded, untuk disambungkan
  • op: sambungkan atau putuskan sambungan
  • createprofile: ya atau tidak
  • kunci: kunci bersama, dikodekan hex64

Perekam Performa Windows

/api/wpr/customtrace (POST)

Mengunggah profil WPR dan mulai melacak menggunakan profil yang diunggah.

Payload

  • isi http multi-bagian yang sesuai

Mengembalikan data

  • Mengembalikan status sesi WPR.

/api/wpr/status (GET)

Mengambil status sesi WPR

Mengembalikan data

  • Status sesi WPR.

/api/wpr/trace (GET)

Menghentikan sesi pelacakan WPR (performa).

Mengembalikan data

  • Mengembalikan file ETL pelacakan

/api/wpr/trace (POST)

Memulai sesi pelacakan WPR (performa).

Parameter

  • profil: Nama profil. Profil yang tersedia disimpan di perfprofiles/profiles.json

Mengembalikan data

  • Pada awalnya, mengembalikan status sesi WPR.

Lihat juga