Справочник по API портала устройств

Статья
07/12/2023

Все компоненты портала устройств Windows основаны на REST API, которые можно использовать для доступа к данным и управления устройством программным способом.

Развертывание приложения

/api/app/packagemanager/package (DELETE)

Удаляет приложение.

Параметры

package: имя удаляемого пакета.

/api/app/packagemanager/package (POST)

Устанавливает приложение.

Параметры

package: имя файла устанавливаемого пакета.

Payload

Многокомпонентный текст 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)

Возвращает список всех аварийных дампов для неопубликованных приложений.

Возвращать данные

Список аварийных дампов для каждого загруженного на стороне приложения

Трассировка событий Windows

/api/etw/providers (GET)

Перечисляет зарегистрированных поставщиков.

Возвращать данные

Список поставщиков, понятное имя и GUID

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

Создает сеанс трассировки событий Windows в режиме реального времени; управляется с помощью websocket.

Возвращать данные

События трассировки событий Windows от включенных поставщиков

Holographic OS

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

Возвращает список поставщиков трассировки событий Windows, относящихся к HoloLens, которые не зарегистрированы в системе.

/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 для портала устройств.

Параметры

обязательно: да, нет или по умолчанию

Голографическое восприятие

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

Принимает обновления WebSocket и запускает клиент восприятия, который отправляет обновления со значением 30 кадров/с.

Параметры

clientmode: "активный" запускает режим визуального отслеживания, когда его невозможно установить пассивно

Голографический тепловой

При использовании этих интерфейсов API температуры см. статью Управление питанием и температурой .

/api/holographic/thermal/stage (GET)

Получение тепловой ступени устройства (0 нормальной, 1 теплой, 2 критической).

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

Откройте websocket (или выполните один http-запрос GET), возвращая список объектов, содержащих следующие данные:

IsSuppressed — определение того, подавляются ли меры по устранению рисков для данного периферийного устройства.
Уровень — последний уровень защиты от температуры для этого периферийного устройства
Mask — маска этого периферийного устройства
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: имя используемой базы данных пространственного сопоставления.

Пример

$.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)

Возвращает состояние системы, включая то, какие карты, привязки и файлы базы данных пространственной реконструкции были импортированы в последний раз.

Смешанный захват реальности

/api/holographic/mrc/file (GET)

Скачивает файл смешанной реальности с устройства. Используйте параметр запроса op=stream для потоковой передачи.

Параметры

filename: имя видеофайла, который требуется получить в шестнадцатеричной кодировке.
op: stream

/api/holographic/mrc/file (DELETE)

Удаляет запись смешанной реальности с устройства.

Параметры

filename: имя удаляемого файла в шестнадцатеричной кодировке.

/api/holographic/mrc/files (GET)

Возвращает список файлов смешанной реальности, хранящихся на устройстве.

/api/holographic/mrc/photo (POST)

Принимает фотографию смешанной реальности и создает файл на устройстве.

Параметры

holo: захват голограмм: true или false (по умолчанию — false)
pv: захват ФОТО камеры: true или false (по умолчанию — false)
RenderFromCamera(только HoloLens 2) отрисовка с точки зрения фото/видеокамеры: true или false (по умолчанию — true).

/api/holographic/mrc/settings (GET)

Возвращает параметры записи смешанной реальности по умолчанию.

/api/holographic/mrc/settings (POST)

Задает параметры захвата смешанной реальности по умолчанию. Некоторые из этих параметров применяются к системным фото- и видеозахвату MRC.

/api/holographic/mrc/status (GET)

Возвращает состояние записи смешанной реальности на портале устройств Windows.

Ответ

Ответ содержит свойство JSON, указывающее, записывает ли портал устройств Windows видео.

{"IsRecording": boolean}

/api/holographic/mrc/thumbnail (GET)

Возвращает эскиз для указанного файла.

Параметры

filename: имя файла, для которого запрашивается эскиз, в шестнадцатеричной кодировке.

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

Запускает запись смешанной реальности.

Параметры

holo: захват голограмм: true или false (по умолчанию — false)
pv: захват камеры PV: true или false (по умолчанию — false)
mic: захват микрофона: 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)

Останавливает текущую запись смешанной реальности.

Потоковая передача Смешанная реальность

Внимание!

Из-за замыкания на себя вы не можете подключиться к потоковой передаче смешанной реальности из приложения на устройстве.

HoloLens поддерживает динамический предварительный просмотр смешанной реальности за счет фрагментированного скачивания фрагментированного mp4-файла.

Потоки смешанной реальности используют один и тот же набор параметров для управления тем, что захватывается:

holo: захват голограмм: true или false
pv: захват фотоэлектрической камеры: true или false
mic: захват микрофона: 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,6 Мбит.

Сеть

/api/networking/ipconfig (GET)

Возвращает текущую IP-конфигурацию.

Сведения об ОС

/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)

Воспроизведение записи.

Параметры

запись: имя записи.

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

Остановка записи.

Параметры

запись: имя записи.

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

Получение типов данных в загруженной записи.

Параметры

запись: имя записи.

Запись имитации восприятия

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

Начните запись. Одновременно может быть активна только одна запись. Один из них должен быть задан: голова, руки, пространственные маски или среда.

Параметры

head: задайте значение 1 для записи данных головы.
руки: для записи данных рук задайте значение 1.
spatialMapping: задайте значение 1 для записи пространственного сопоставления.
environment: задайте значение 1 для записи данных среды.
name: имя записи.
singleSpatialMappingFrame: задайте значение 1, чтобы записать только один кадр пространственного сопоставления.

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

Получение состояния записи.

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

Остановите текущую запись. Запись будет возвращена в виде файла.

Данные о производительности

/api/resourcemanager/processes (GET)

Возвращает список запущенных процессов с подробными сведениями.

Возвращать данные

JSON со списком процессов и подробными сведениями для каждого процесса

/api/resourcemanager/systemperf (GET)

Возвращает статистику производительности системы (операции ввода-вывода для чтения и записи, статистика памяти и т. д.

Возвращать данные

JSON с системными сведениями: ЦП, GPU, память, сеть, операции ввода-вывода

Мощный

/api/power/battery (GET)

Возвращает текущее состояние батареи.

/api/power/state (GET)

Проверяет, находится ли система в состоянии низкого энергопотребления.

Удаленное управление

/api/control/restart (POST)

Перезапуск целевого устройства.

/api/control/shutdown (POST)

Завершает работу целевого устройства.

Диспетчер задач

/api/taskmanager/app (DELETE)

Останавливает современное приложение.

Параметры

package: полное имя пакета приложения в шестнадцатеричной кодировке.
forcetop: принудительное завершение всех процессов (=да)

/api/taskmanager/app (POST)

Запуск современного приложения

Параметры

appid: PRAID запускаемого приложения в шестнадцатеричной кодировке
package: полное имя пакета приложения в шестнадцатеричной кодировке.

Управление Wi-Fi

/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, в шестнадцатеричной кодировке, для подключения к
op: подключение или отключение
createprofile: да или нет.
key: общий ключ, в шестнадцатеричной кодировке

Средство записи производительности Windows

/api/wpr/customtrace (POST)

Отправляет профиль WPR и начинает трассировку с использованием отправленного профиля.

Payload

многокомпонентный текст 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 портала устройств

Развертывание приложения

Коллекция дампов

Трассировка событий Windows

Holographic OS

Голографическое восприятие

Голографический тепловой

Диспетчер карт

Скачивание, отправка и удаление файлов

Экспорт

Импорт

Другое

Смешанный захват реальности

Потоковая передача Смешанная реальность

Сеть

Сведения об ОС

Управление имитацией восприятия

Воспроизведение имитации восприятия

Запись имитации восприятия

Данные о производительности

Мощный

Удаленное управление

Диспетчер задач

Управление Wi-Fi

Средство записи производительности Windows

См. также раздел

Дополнительные ресурсы