Dokumentacja interfejsu API portalu urządzeń

Wszystko w portalu urządzeń z systemem Windows jest oparte na interfejsie API REST, którego można użyć do uzyskiwania dostępu do danych i programowego kontrolowania urządzenia.

Wdrażanie aplikacji

/api/app/packagemanager/package (DELETE)

Odinstalowuje aplikację.

Parametry

• package: Nazwa pliku pakietu do odinstalowania.

/api/app/packagemanager/package (POST)

Instaluje aplikację.

Parametry

• package: Nazwa pliku pakietu do zainstalowania.

Ładunku

• wieloczęściowa zgodność z treścią http

/api/app/packagemanager/packages (GET)

Pobiera listę zainstalowanych aplikacji w systemie. Zawiera szczegóły.

Zwracanie danych

• Lista zainstalowanych pakietów ze szczegółami

/api/app/packagemanager/state (GET)

Pobiera stan instalacji aplikacji w toku.

Kolekcja zrzutów

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

Wyłącza zbieranie zrzutów awaryjnych dla ładowanej bezpośrednio aplikacji.

Parametry

• packageFullName: nazwa pakietu

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

Pobiera ustawienia kolekcji zrzutów awaryjnych ładowanych bezpośrednio aplikacji.

Parametry

• packageFullName: nazwa pakietu

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

Włącza i ustawia ustawienia kontrolki zrzutu dla aplikacji ładowanej bezpośrednio.

Parametry

• packageFullName: nazwa pakietu

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

Usuwa zrzut awaryjny aplikacji załadowanej bezpośrednio.

Parametry

• packageFullName: nazwa pakietu
• fileName: nazwa pliku zrzutu

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

Pobiera zrzut awaryjny dla załadowanej aplikacji.

Parametry

• packageFullName: nazwa pakietu
• fileName: nazwa pliku zrzutu

Zwracanie danych

• Plik zrzutu. Sprawdź za pomocą narzędzia WinDbg lub Visual Studio.

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

Zwraca listę wszystkich zrzutów awaryjnych dla aplikacji załadowanych bezpośrednio.

Zwracanie danych

• Lista zrzutów awaryjnych na załadowaną po stronie aplikacji

ETW

/api/etw/providers (GET)

Wylicza zarejestrowanych dostawców.

Zwracanie danych

• Lista dostawców, przyjazna nazwa i identyfikator GUID

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

Tworzy sesję ETW w czasie rzeczywistym; zarządzane za pośrednictwem protokołu websocket.

Zwracanie danych

• Zdarzenia ETW od dostawców z włączoną obsługą

System operacyjny Holographic

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

Zwraca listę dostawców ETW specyficznych dla urządzenia HoloLens, którzy nie są zarejestrowani w systemie.

/api/holographic/os/services (GET)

Zwraca stany wszystkich uruchomionych usług.

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

Pobiera przechowywany adres IPD (odległość międzypupillarna) w milimetrach.

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

Ustawia adres IPD.

Parametry

• ipd: Nowa wartość IPD, która ma być ustawiona w milimetrach

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

Pobiera wymagania protokołu HTTPS dotyczące portalu urządzeń.

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

Ustawia wymagania protokołu HTTPS dla portalu urządzeń.

Parametry

• wymagane: tak, nie lub wartość domyślna

Postrzeganie holograficzne

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

Akceptuje uaktualnienia protokołu WebSocket i uruchamia klienta percepcji, który wysyła aktualizacje z prędkością 30 klatek na sekundę.

Parametry

• clientmode: "aktywny" wymusza tryb śledzenia wizualnego, gdy nie można go ustanowić pasywnie

Termalne holograficzne

W przypadku korzystania z tych interfejsów API termicznych zapoznaj się z artykułem dotyczącym zarządzania energią i temperaturą.

/api/holographic/thermal/stage (GET)

Uzyskaj etap cieplny urządzenia (0 normalny, 1 ciepły, 2 krytyczny).

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

Otwórz zestaw websocket (lub wykonaj pojedyncze zapytanie HTTP GET), zwracając listę obiektów zawierających następujące elementy:

• IsSuppressed — identyfikowanie, czy dane urządzenie peryferyjne ma pominięte środki zaradcze
• Poziom — najnowszy poziom ograniczania ryzyka termicznego dla tego urządzenia peryferyjnego
• Maska — maska tego urządzenia peryferyjnego
• ThermalScore — najnowszy wynik cieplny dla tego urządzenia peryferyjnego

Obiekty są nazwane przez nazwę urządzenia peryferyjnego (przykład: bateria)

/api/holographic/thermal/setMitigationLevel (POST)

Zmiana poziomu ograniczania ryzyka zgłaszanego dla danego urządzenia peryferyjnego

Parametry

• maska: maska bitów z pojedynczym zestawem bitów dla urządzenia peryferyjnego zainteresowania (zobacz PowerThermalPeripheralFlags , aby uzyskać szczegółowe informacje)
• poziom: nowy poziom do użycia (0–3)

/api/holographic/thermal/setThermalScore (POST)

Zmiana wyniku cieplnego zgłaszanego dla danego urządzenia peryferyjnego

Parametry

• maska: maska bitów z pojedynczym bitem ustawionym dla urządzenia peryferyjnego zainteresowania (zobacz PowerThermalPeripheralFlags , aby uzyskać szczegółowe informacje)
• thermalScore: nowy wynik termiczny do użycia (100-0)

Menedżer map

/api/holographic/mapmanager/mapFiles (GET)

Pobiera listę dostępnych plików mapy (.mapx).

/api/holographic/mapmanager/anchorFiles (GET)

Pobiera listę dostępnych plików kotwicy (.ancx).

/api/holographic/mapmanager/srdbFiles (GET)

Pobiera listę dostępnych plików bazy danych rekonstrukcji przestrzennej (srdb).

/api/holographic/mapmanager/getanchors (GET)

Pobiera listę utrwalone kotwic dla bieżącego użytkownika.

Pobieranie/przekazywanie/usuwanie plików

/api/holographic/mapmanager/download (GET)

Pobiera plik bazy danych mapy, kotwicy lub rekonstrukcji przestrzennej. Plik musi zostać wcześniej przekazany lub wyeksportowany.

Parametry

• FileName: nazwa pliku do pobrania.

Przykład:

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

/api/holographic/mapmanager/upload (POST)

Przekazuje plik bazy danych mapy, kotwicy lub rekonstrukcji przestrzennej. Po przekazaniu pliku można go później zaimportować i używać przez system.

Parametry

• plik: nazwa pliku do przekazania.

Przykład:

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)

Usuwa plik bazy danych mapy, kotwicy lub rekonstrukcji przestrzennej. Plik musi zostać wcześniej przekazany lub wyeksportowany.

Parametry

• FileName: nazwa pliku do usunięcia.

Przykład:

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

Eksportowanie

/api/holographic/mapmanager/export (POST)

Eksportuje mapę używaną obecnie przez system. Po wyeksportowaniu można go pobrać.

Przykład:

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

/api/holographic/mapmanager/exportanchors (POST)

Eksportuje mapę używaną obecnie przez system. Po wyeksportowaniu można go pobrać. Przykład:

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

/api/holographic/mapmanager/exportmapandanchors (POST)

Eksportuje mapę i kotwice używane obecnie przez system. Po wyeksportowaniu można je pobrać. Przykład:

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

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Eksportuje bazę danych mapy i rekonstrukcji przestrzennej, która jest obecnie używana przez system. Po wyeksportowaniu można je pobrać.

Przykład:

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

Importuj

/api/holographic/mapmanager/import (POST)

Wskazuje system, którego mapowania należy użyć. Można wywołać dla plików, które zostały wyeksportowane lub przekazane.

Parametry

• FileName: nazwa mapy do użycia.

Przykład:

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

/api/holographic/mapmanager/importanchors (POST)

Wskazuje system, którego należy używać kotwic. Można wywołać dla plików, które zostały wyeksportowane lub przekazane.

Parametry

• FileName: nazwa kotwic do użycia.

Przykład:

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

/api/holographic/mapmanager/importpatialmappingdb (POST)

Wskazuje system, którego należy użyć bazy danych rekonstrukcji przestrzennej. Można wywołać dla plików, które zostały wyeksportowane lub przekazane.

Parametry

• FileName: nazwa bazy danych mapowania przestrzennego do użycia.

Przykład:

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

Inne

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Zresetuj system mapę, kotwice i bazę danych rekonstrukcji przestrzennej.

Przykład:

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

/api/holographic/mapmanager/status (GET)

Pobiera stan systemu, w tym ostatnio zaimportowane pliki bazy danych mapy, kotwic i rekonstrukcji przestrzennej.

przechwytywanie Mixed Reality

/api/holographic/mrc/file (GET)

Pobiera plik rzeczywistości mieszanej z urządzenia. Użyj parametru zapytania op=stream do przesyłania strumieniowego.

Parametry

• nazwa pliku: Nazwa, szesnastkowy kodowany, pliku wideo do pobrania
• op: stream

/api/holographic/mrc/file (DELETE)

Usuwa nagranie rzeczywistości mieszanej z urządzenia.

Parametry

• nazwa pliku: nazwa, szesnastkowy kodowany, pliku do usunięcia

/api/holographic/mrc/files (GET)

Zwraca listę plików rzeczywistości mieszanej przechowywanych na urządzeniu.

/api/holographic/mrc/photo (POST)

Wykonuje zdjęcie rzeczywistości mieszanej i tworzy plik na urządzeniu.

Parametry

• holo: przechwytywanie hologramów: prawda lub fałsz (wartość domyślna to false)
• pv: przechwytywanie kamery PV: prawda lub fałsz (wartość domyślna to false)
• RenderFromCamera: (tylko HoloLens 2) renderowany z perspektywy aparatu fotograficznego/wideo: prawda lub fałsz (wartość domyślna to true)

/api/holographic/mrc/settings (GET)

Pobiera domyślne ustawienia przechwytywania rzeczywistości mieszanej.

/api/holographic/mrc/settings (POST)

Ustawia domyślne ustawienia przechwytywania rzeczywistości mieszanej. Niektóre z tych ustawień są stosowane do przechwytywania zdjęć i wideo MRC systemu.

/api/holographic/mrc/status (GET)

Pobiera stan przechwytywania rzeczywistości mieszanej w portalu urządzeń z systemem Windows.

Reakcja

Odpowiedź zawiera właściwość JSON, która wskazuje, czy portal urządzeń z systemem Windows nagrywa wideo, czy nie.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Pobiera obraz miniatury dla określonego pliku.

Parametry

• nazwa pliku: nazwa, szesnastkowy kodowany, pliku, dla którego żądana jest miniatura

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

Rozpoczyna nagrywanie rzeczywistości mieszanej.

Parametry

• holo: przechwytywanie hologramów: prawda lub fałsz (wartość domyślna to false)
• pv: przechwytywanie kamery PV: prawda lub fałsz (wartość domyślna to false)
• mikrofon: przechwytywanie mikrofonu: prawda lub fałsz (wartość domyślna to false)
• sprzężenie zwrotne: przechwytywanie dźwięku aplikacji: prawda lub fałsz (wartość domyślna to false)
• RenderFromCamera: (tylko HoloLens 2) renderowany z perspektywy aparatu fotograficznego/wideo: prawda lub fałsz (wartość domyślna to true)
• vstab: (tylko HoloLens 2) włącz stabilizację wideo: prawda lub fałsz (wartość domyślna to true)
• vstabbuffer: (tylko HoloLens 2) opóźnienie buforu stabilizacji wideo: 0 do 30 klatek (domyślnie 15 ramek)

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

Zatrzymuje bieżące rejestrowanie rzeczywistości mieszanej.

przesyłanie strumieniowe Mixed Reality

Przestroga

Z powodu izolacji sprzężenia zwrotnego nie można nawiązać połączenia z przesyłaniem strumieniowym rzeczywistości mieszanej z poziomu aplikacji na urządzeniu.

Urządzenie HoloLens obsługuje podgląd na żywo rzeczywistości mieszanej za pośrednictwem fragmentowanego pobierania fragmentowanego pliku mp4.

Strumienie rzeczywistości mieszanej współużytkują ten sam zestaw parametrów, aby kontrolować przechwycone dane:

• holo: przechwytywanie hologramów: prawda lub fałsz
• pv: przechwytywanie kamery PV: prawda lub fałsz
• mikrofon: przechwytywanie mikrofonu: prawda lub fałsz
• sprzężenia zwrotnego: przechwytywanie dźwięku aplikacji: prawda lub fałsz

Jeśli żadna z nich nie zostanie określona, zostaną przechwycone hologramy, aparat fotograficzny/wideo i dźwięk aplikacji.

Jeśli są określone, nieokreślone parametry będą domyślnie mieć wartość false

Parametry opcjonalne (tylko HoloLens 2)

• RenderFromCamera: renderuj z perspektywy aparatu fotograficznego/wideo: prawda lub fałsz (wartość domyślna to true)
• vstab: włącz stabilizację wideo: prawda lub fałsz (wartość domyślna to false)
• vstabbuffer: opóźnienie buforu stabilizacji wideo: od 0 do 30 ramek (domyślnie 15 ramek)

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

Strumień 1280x720p 30fps 5Mbit.

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

Strumień 1280x720p 30fps 5Mbit.

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

Strumień 854x480p 30fps 2.5Mbit.

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

Strumień 428x240p 15fps 0.6Mbit.

Sieć

/api/networking/ipconfig (GET)

Pobiera bieżącą konfigurację adresu IP.

Informacje o systemie operacyjnym

/api/os/info (GET)

Pobiera informacje o systemie operacyjnym.

/api/os/machinename (GET)

Pobiera nazwę maszyny.

/api/os/machinename (POST)

Ustawia nazwę maszyny.

Parametry

• name: Nowa nazwa komputera, szesnastkowy kodowany, do ustawienia

Kontrola symulacji percepcji

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

Pobiera tryb symulacji.

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

Ustawia tryb symulacji.

Parametry

• mode: tryb symulacji: domyślny, symulacja, zdalna, starsza wersja

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

Usuwanie strumienia kontrolki.

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

Otwórz połączenie protokołu WebSocket dla strumienia sterowania.

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

Utwórz strumień kontrolny (wymagany priorytet) lub opublikuj dane w utworzonym strumieniu (wymagany identyfikator streamId). Dane publikowane powinny mieć typ "application/octet-stream".

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

Zażądaj strumienia wideo symulacji zawierającego zawartość renderowaną w systemie w trybie symulacji. Początkowo zostanie wysłany prosty nagłówek deskryptora formatu, a następnie tekstury zakodowane w formacie H.264, z których każdy poprzedza nagłówek wskazujący indeks oka i rozmiar tekstury.

Odtwarzanie symulacji percepcji

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

Usuń nagranie.

Parametry

• nagranie: nazwa nagrania do usunięcia.

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

Przekaż nagranie.

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

Pobierz wszystkie nagrania.

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

Pobierz bieżący stan odtwarzania nagrania.

Parametry

• nagranie: nazwa nagrania.

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

Zwolnij nagranie.

Parametry

• nagranie: nazwa nagrania do zwolnienia.

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

Załaduj nagranie.

Parametry

• nagranie: nazwa nagrania do załadowania.

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

Pobierz wszystkie załadowane nagrania.

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

Wstrzymaj nagrywanie.

Parametry

• nagranie: nazwa nagrania.

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

Odtwórz nagranie.

Parametry

• nagranie: Nazwa nagrania.

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

Zatrzymaj nagrywanie.

Parametry

• nagranie: Nazwa nagrania.

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

Pobierz typy danych w załadowanym nagraniu.

Parametry

• nagranie: Nazwa nagrania.

Rejestrowanie symulacji percepcji

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

Rozpocznij nagrywanie. Tylko jedno nagranie może być aktywne jednocześnie. Należy ustawić jedną z tych opcji: head, hands, spatialMapping lub environment.

Parametry

• head: ustaw wartość 1, aby rejestrować dane głowy.
• hands: ustaw wartość na 1, aby rejestrować dane ręczne.
• spatialMapping: ustaw wartość na 1, aby rejestrować mapowanie przestrzenne.
• środowisko: ustaw wartość na 1, aby rejestrować dane środowiska.
• name: Nazwa nagrania.
• singleSpatialMappingFrame: ustaw wartość na 1, aby rejestrować tylko jedną ramkę mapowania przestrzennego.

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

Uzyskiwanie stanu rejestrowania.

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

Zatrzymaj bieżące nagranie. Nagranie zostanie zwrócone jako plik.

Dane wydajności

/api/resourcemanager/processes (GET)

Zwraca listę uruchomionych procesów ze szczegółami.

Zwracanie danych

• Kod JSON z listą procesów i szczegółów dla każdego procesu

/api/resourcemanager/systemperf (GET)

Zwraca statystyki wydajności systemu (odczyt/zapis operacji we/wy, statystyki pamięci itp.

Zwracanie danych

• Kod JSON z informacjami o systemie: procesor CPU, procesor GPU, pamięć, sieć, we/wy

Zasilanie

/api/power/battery (GET)

Pobiera bieżący stan baterii.

/api/power/state (GET)

Sprawdza, czy system jest w stanie niskiego zasilania.

Zdalne sterowanie

/api/control/restart (POST)

Uruchamia ponownie urządzenie docelowe.

/api/control/shutdown (POST)

Wyłącza urządzenie docelowe.

Menedżer zadań

/api/taskmanager/app (DELETE)

Zatrzymuje nowoczesną aplikację.

Parametry

• package: Pełna nazwa pakietu aplikacji, kodowany szesnastkowy szesnastkowy
• forcetop: Wymuszaj zatrzymanie wszystkich procesów (=yes)

/api/taskmanager/app (POST)

Uruchamia nowoczesną aplikację

Parametry

• appid: PRAID aplikacji do uruchomienia, kodowany szesnastkowy szesnastkowy
• package: Pełna nazwa pakietu aplikacji, kodowany szesnastkowy szesnastkowy

Zarządzanie siecią Wi-Fi

/api/wifi/interfaces (GET)

Wylicza interfejsy sieci bezprzewodowej.

Zwracanie danych

• Lista interfejsów bezprzewodowych ze szczegółami (identyfikator GUID, opis itp.)

/api/wifi/network (DELETE)

Usuwa profil skojarzony z siecią w określonym interfejsie.

Parametry

• interfejs: identyfikator GUID interfejsu sieciowego
• profil: nazwa profilu

/api/wifi/networks (GET)

Wylicza sieci bezprzewodowe w określonym interfejsie sieciowym.

Parametry

• interfejs: identyfikator GUID interfejsu sieciowego

Zwracanie danych

• Lista sieci bezprzewodowych znalezionych w interfejsie sieciowym ze szczegółami

/api/wifi/network (POST)

Łączy się lub rozłącza z siecią w określonym interfejsie.

Parametry

• interfejs: identyfikator GUID interfejsu sieciowego
• ssid: ssid, szesnastkowy zakodowany w celu nawiązania połączenia z
• op: łączenie lub rozłączanie
• createprofile: tak lub nie
• klucz: klucz wspólny, kodowany szesnastkowy

Windows Performance Recorder

/api/wpr/customtrace (POST)

Przekazuje profil funkcji WPR i rozpoczyna śledzenie przy użyciu przekazanego profilu.

Ładunku

• wieloczęściowa zgodność z treścią http

Zwracanie danych

• Zwraca stan sesji WPR.

/api/wpr/status (GET)

Pobiera stan sesji WPR

Zwracanie danych

• Stan sesji funkcji WPR.

/api/wpr/trace (GET)

Zatrzymuje sesję śledzenia WPR (wydajność).

Zwracanie danych

• Zwraca plik ETL śledzenia

/api/wpr/trace (POST)

Uruchamia sesję śledzenia WPR (wydajność).

Parametry

• profil: nazwa profilu. Dostępne profile są przechowywane w pliku perfprofiles/profiles.json

Zwracanie danych

• Na początku zwraca stan sesji WPR.

Zobacz też

• Korzystanie z portalu urządzeń z systemem Windows
• Dokumentacja podstawowego interfejsu API portalu urządzeń (UWP)