Справочник по 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 (DELETE)

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

ПараметрыParameters

  • Пакет: имя файла удаляемого пакета.package : File name of the package to be uninstalled.

/АПИ/АПП/паккажеманажер/паккаже (POST)/api/app/packagemanager/package (POST)

Устанавливает приложениеInstalls an App

ПараметрыParameters

  • Пакет: имя файла устанавливаемого пакета.package : File name of the package to be installed.

PayloadPayload

  • текст HTTP из нескольких частейmulti-part conforming http body

/АПИ/АПП/паккажеманажер/паккажес (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

/АПИ/АПП/паккажеманажер/Стате (GET)/api/app/packagemanager/state (GET)

Возвращает состояние выполняющейся установки приложения.Gets the status of in progress app installation

Дамп коллекцииDump collection

/АПИ/дебуг/ДУМП/усермоде/крашконтрол (удаление)/api/debug/dump/usermode/crashcontrol (DELETE)

Отключает сбор аварийных дампов для приложения загруженные неопубликованныеDisables crash dump collection for a sideloaded app

ПараметрыParameters

  • Полноеимяпакета: имя пакетаpackageFullname : package name

/АПИ/дебуг/ДУМП/усермоде/крашконтрол (GET)/api/debug/dump/usermode/crashcontrol (GET)

Получение параметров для коллекции аварийных дампов приложений загруженные неопубликованныеGets settings for sideloaded apps crash dump collection

ПараметрыParameters

  • Полноеимяпакета: имя пакетаpackageFullname : package name

/АПИ/дебуг/ДУМП/усермоде/крашконтрол (POST)/api/debug/dump/usermode/crashcontrol (POST)

Включает и задает параметры управления дампом для приложения загруженные неопубликованныеEnables and sets dump control settings for a sideloaded app

ПараметрыParameters

  • Полноеимяпакета: имя пакетаpackageFullname : package name

/АПИ/дебуг/ДУМП/усермоде/крашдумп (удаление)/api/debug/dump/usermode/crashdump (DELETE)

Удаляет аварийный дамп для приложения загруженные неопубликованныеDeletes a crash dump for a sideloaded app

ПараметрыParameters

  • Полноеимяпакета: имя пакетаpackageFullname : package name
  • имя_файла: имя файла дампаfileName : dump file name

/АПИ/дебуг/ДУМП/усермоде/крашдумп (GET)/api/debug/dump/usermode/crashdump (GET)

Получает аварийный дамп для приложения загруженные неопубликованныеRetrieves a crash dump for a sideloaded app

ПараметрыParameters

  • Полноеимяпакета: имя пакетаpackageFullname : package name
  • имя_файла: имя файла дампаfileName : dump file name

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

  • Файл дампа.Dump file. Проверка с помощью WinDbg или Visual StudioInspect with WinDbg or Visual Studio

/АПИ/дебуг/ДУМП/усермоде/думпс (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

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

/АПИ/ЕТВ/провидерс (GET)/api/etw/providers (GET)

Перечисляет зарегистрированные поставщикиEnumerates registered providers

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

  • Список поставщиков, понятное имя и идентификатор GUIDList of providers, friendly name and GUID

/АПИ/ЕТВ/Сессион/реалтиме (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

Holographic OSHolographic OS

/АПИ/холографик/ОС/ЕТВ/кустомпровидерс (GET)/api/holographic/os/etw/customproviders (GET)

Возвращает список поставщиков ETW, которые не зарегистрированы в системе.Returns a list of HoloLens specific ETW providers that are not registered with the system

/АПИ/холографик/ОС/сервицес (GET)/api/holographic/os/services (GET)

Возвращает состояния всех служб, на которых выполняются службы.Returns the states of all services running.

/АПИ/холографик/ОС/Сеттингс/ИПД (GET)/api/holographic/os/settings/ipd (GET)

Получает хранимую IPD (Интерпупиллари distance) в миллиметрахGets the stored IPD (Interpupillary distance) in millimeters

/АПИ/холографик/ОС/Сеттингс/ИПД (POST)/api/holographic/os/settings/ipd (POST)

Задает IPDSets the IPD

ПараметрыParameters

  • IPD: новое значение IPD для установки в миллиметрахipd : New IPD value to be set in millimeters

/АПИ/холографик/ОС/вебманажемент/Сеттингс/хттпс (GET)/api/holographic/os/webmanagement/settings/https (GET)

Получение требований HTTPS для Портала устройствGet HTTPS requirements for the Device Portal

/АПИ/холографик/ОС/вебманажемент/Сеттингс/хттпс (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

/АПИ/холографик/перцептион/клиент (GET/WebSocket)/api/holographic/perception/client (GET/WebSocket)

Принимает обновления WebSocket и запускает клиент-восприятие, которое отправляет обновления с частотой 30 кадров/с.Accepts websocket upgrades and runs a perception client that sends updates at 30 fps.

ПараметрыParameters

  • клиентмоде: "Active" запускает режим отслеживания визуального элемента, если он не может быть установлен в пассивном режимеclientmode: "active" forces visual tracking mode when it can't be established passively

Голограмма holographicHolographic Thermal

/АПИ/холографик/сермал/стаже (GET)/api/holographic/thermal/stage (GET)

Получите температурный этап устройства (0 нормальная, 1 тепло, 2 критическая)Get the thermal stage of the device (0 normal, 1 warm, 2 critical)

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

/АПИ/холографик/мапманажер/мапфилес (GET)/api/holographic/mapmanager/mapFiles (GET)

Возвращает список доступных файлов карт (. мапкс).Gets the list of the available map files (.mapx).

/АПИ/холографик/мапманажер/анчорфилес (GET)/api/holographic/mapmanager/anchorFiles (GET)

Возвращает список доступных файлов привязки (. анккс).Gets the list of available anchor files (.ancx).

/АПИ/холографик/мапманажер/срдбфилес (GET)/api/holographic/mapmanager/srdbFiles (GET)

Возвращает список доступных файлов базы данных пространственной реконструкции (. срдб).Gets the list of available spatial reconstruction database files (.srdb).

/АПИ/холографик/мапманажер/жетанчорс (GET)/api/holographic/mapmanager/getanchors (GET)

Возвращает список материализованных привязок для текущего пользователя.Gets the list of persisted anchors for the current user.

Скачать, отправить или удалить файлыDownload/Upload/Delete Files

/АПИ/холографик/мапманажер/Довнлоад (GET)/api/holographic/mapmanager/download (GET)

Скачивает файл схемы, привязки или базы данных пространственного восстановления.Downloads a map, anchor, or spatial reconstruction database file. Файл должен быть предварительно отправлен или экспортирован.The file must have been previously uploaded or exported.

ПараметрыParameters

  • FileName: имя файла для скачивания.FileName: Name of file to download.

ПримерExample:

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

/АПИ/холографик/мапманажер/уплоад (POST)/api/holographic/mapmanager/upload (POST)

Отправляет файл схемы, привязки или пространственной реконструкции базы данных.Uploads a map, anchor, or spatial reconstruction database file. После отправки файла его можно будет импортировать в систему в дальнейшем.Once a file is uploaded it can later be imported to be used by the system.

ПараметрыParameters

  • файл: имя файла для отправки.file: Name of the file to upload.

ПримерExample:

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'
})

/АПИ/холографик/мапманажер/делете (POST)/api/holographic/mapmanager/delete (POST)

Удаляет файл схемы, привязки или базы данных пространственной реконструкции.Deletes a map, anchor, or spatial reconstruction database file. Файл должен быть предварительно отправлен или экспортирован.The file must have been previously uploaded or exported.

ПараметрыParameters

  • FileName: имя удаляемого файла.FileName: Name of file to delete.

ПримерExample:

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

ЭкспортExport

/АПИ/холографик/мапманажер/експорт (POST)/api/holographic/mapmanager/export (POST)

Экспортирует текущую карту, используемую системой.Exports the map currently in use by the system. После экспорта его можно скачать.Once exported, it can be downloaded.

ПримерExample:

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

/АПИ/холографик/мапманажер/експортанчорс (POST)/api/holographic/mapmanager/exportanchors (POST)

Экспортирует текущую карту, используемую системой.Exports the map currently in use by the system. После экспорта его можно скачать.Once exported, it can be downloaded. ПримерExample:

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

/АПИ/холографик/мапманажер/експортмапанданчорс (POST)/api/holographic/mapmanager/exportmapandanchors (POST)

Экспортирует карту и привязки, используемые системой в настоящее время.Exports the map and anchors currently in use by the system. После экспорта их можно скачать.Once are exported, they can be downloaded. ПримерExample:

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

/АПИ/холографик/мапманажер/експортмапандспатиалмаппингдб (POST)/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

Экспортирует базу данных Map и spatial реконструкции, используемую системой в данный момент.Exports the map and spatial reconstruction database currently in use by the system. После экспорта их можно скачать.Once they are exported, they can be downloaded.

ПримерExample:

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

ИмпортImport

/АПИ/холографик/мапманажер/импорт (POST)/api/holographic/mapmanager/import (POST)

Указывает системе, какую карту следует использовать в настоящее время.Indicates to the system which map should be used be currently used. Может вызываться для файлов, которые были экспортированы или переданы.Can be called on files that have been exported or uploaded.

ПараметрыParameters

  • FileName: имя используемой схемы.FileName: Name of the map to be used.

ПримерExample:

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

/АПИ/холографик/мапманажер/импортанчорс (POST)/api/holographic/mapmanager/importanchors (POST)

Указывает системе, какие привязки должны использоваться в текущий момент.Indicates to the system which anchors should be used be currently used. Может вызываться для файлов, которые были экспортированы или переданы.Can be called on files that have been exported or uploaded.

ПараметрыParameters

  • FileName: имя используемых привязок.FileName: Name of the anchors to be used.

ПримерExample:

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

/АПИ/холографик/мапманажер/импортспатиалмаппингдб (POST)/api/holographic/mapmanager/importspatialmappingdb (POST)

Указывает на систему, в которой должна использоваться база данных пространственной реконструкции.Indicates to the system which spatial reconstruction database should be used be currently used. Может вызываться для файлов, которые были экспортированы или переданы.Can be called on files that have been exported or uploaded.

ПараметрыParameters

  • FileName: имя базы данных пространственного сопоставления, которая будет использоваться.FileName: Name of the spatial mapping db to be used.

ПримерExample:

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

ДругоеOther

/АПИ/холографик/мапманажер/ресетмапанданчорсандсрдб (POST)/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

Сбросьте систему на карту, привязки и базу данных пространственной реконструкции.Reset the system the map, anchors and spatial reconstruction database.

ПримерExample:

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

/АПИ/холографик/мапманажер/статус (GET)/api/holographic/mapmanager/status (GET)

Возвращает состояние системы, включая данные о сопоставлении, привязках и базах данных пространственной реконструкции, которые были импортированы в последний раз.Gets the status of the system, including which map, anchors, and spatial reconstruction database files that were last imported.

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

/АПИ/холографик/МРК/филе (GET)/api/holographic/mrc/file (GET)

Скачивает файл смешанной реальности с устройства.Downloads a mixed reality file from the device. Use Op = потоковый параметр запроса для потоковой передачи.Use op=stream query parameter for streaming.

ПараметрыParameters

  • имя файла: имя, hex64 в кодировке для получаемого видео.filename : Name, hex64 encoded, of the video file to get
  • Op: Streamop : stream

/АПИ/холографик/МРК/филе (удаление)/api/holographic/mrc/file (DELETE)

Удаляет запись смешанной реальности с устройства.Deletes a mixed reality recording from the device.

ПараметрыParameters

  • filename: Name, hex64 Encoded (имя файла), которое нужно удалить.filename : Name, hex64 encoded, of the file to delete

/АПИ/холографик/МРК/Филес (GET)/api/holographic/mrc/files (GET)

Возвращает список файлов смешанной реальности, хранящихся на устройствеReturns the list of mixed reality files stored on the device

/АПИ/холографик/МРК/фото (POST)/api/holographic/mrc/photo (POST)

Принимает фотографию смешанной реальности и создает файл на устройствеTakes a mixed reality photo and creates a file on the device

ПараметрыParameters

  • Холо: голограммы захвата: true или false (по умолчанию — false)holo : capture holograms: true or false (defaults to false)
  • ПС: захват ПС Camera: true или false (по умолчанию — false)pv : capture PV camera: true or false (defaults to false)
  • Рендерфромкамера: (только HoloLens 2) отрисовывается с точки зрения фотографии или видеокамеры: true или false (значение по умолчанию — true)RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)

/АПИ/холографик/МРК/Сеттингс (GET)/api/holographic/mrc/settings (GET)

Получает параметры записи смешанной реальности по умолчаниюGets the default mixed reality capture settings

/АПИ/холографик/МРК/Сеттингс (POST)/api/holographic/mrc/settings (POST)

Задает параметры записи смешанной реальности по умолчанию.Sets the default mixed reality capture settings. Некоторые из этих параметров применяются к фотографии и видеозаписи системы требований к системе.Some of these settings are applied to the system's MRC photo and video capture.

/АПИ/холографик/МРК/статус (GET)/api/holographic/mrc/status (GET)

Возвращает состояние захвата смешанной реальности на портале устройств Windows.Gets the state of mixed reality capture within the Windows Device Portal.

*Ответ _*Response _

Ответ содержит свойство JSON, указывающее, записывается ли видео на портале устройств Windows.The response contains a JSON property indicating if Windows Device Portal is recording video or not.

{"IsRecording" : boolean}

_ /АПИ/холографик/МРК/сумбнаил (Get)*_ /api/holographic/mrc/thumbnail (GET)*

Получает эскиз изображения для указанного файла.Gets the thumbnail image for the specified file.

ПараметрыParameters

  • filename: Name, hex64 Encoded, файла, для которого запрашивается эскиз.filename: Name, hex64 encoded, of the file for which the thumbnail is being requested

/АПИ/холографик/МРК/видео/контрол/старт (POST)/api/holographic/mrc/video/control/start (POST)

Запуск записи смешанной реальностиStarts a mixed reality recording

ПараметрыParameters

  • Холо: голограммы захвата: true или false (по умолчанию — false)holo : capture holograms: true or false (defaults to false)
  • ПС: захват ПС Camera: 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)
  • Рендерфромкамера: (только HoloLens 2) отрисовывается с точки зрения фотографии или видеокамеры: true или false (значение по умолчанию — true)RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)
  • встаб: (только HoloLens 2) Enable Video стабилизации: true или false (значение по умолчанию — true)vstab : (HoloLens 2 only) enable video stabilization: true or false (defaults to true)
  • встаббуффер: (только HoloLens 2) задержка буфера стабилизации видео: от 0 до 30 кадров (по умолчанию — 15 кадров)vstabbuffer: (HoloLens 2 only) video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

/АПИ/холографик/МРК/видео/контрол/стоп (POST)/api/holographic/mrc/video/control/stop (POST)

Останавливает текущую запись смешанной реальностиStops the current mixed reality recording

Потоковая передача смешанной реальностиMixed Reality Streaming

Внимание!

Из-за изоляции замыкания на себя невозможно подключиться к потоковой передаче смешанной реальности из приложения на устройстве.Because of loopback isolation, you can't connect to Mixed Reality Streaming from inside an app on a device.

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:

  • Холо: голограммы записи: true или falseholo : capture holograms: true or false
  • ПС: запись камеры PV: true или falsepv : capture PV camera: true or false
  • микрофон: записать микрофон: true или falsemic : capture microphone: true or false
  • замыкание на себя: запись звука приложения: true или falseloopback : capture app audio: true or false

Если ни один из этих элементов не указан: будут записываться голограммы, Фото-и видеокамера и звук приложения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)

  • Рендерфромкамера: прорисовка с точки зрения фотографии или видеокамеры: true или false (по умолчанию — true)RenderFromCamera : render from perspective of photo/video camera: true or false (defaults to true)
  • встаб: enable Video стабилизации: true или false (по умолчанию — false)vstab : enable video stabilization: true or false (defaults to false)
  • встаббуффер: задержка буфера стабилизации видео: от 0 до 30 кадров (по умолчанию — 15 кадров)vstabbuffer: video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

live.mp4/АПИ/холографик/стреам/(GET)/api/holographic/stream/live.mp4 (GET)

1280x720p 30fps 5Mbit Stream.A 1280x720p 30fps 5Mbit stream.

live_high.mp4/АПИ/холографик/стреам/(GET)/api/holographic/stream/live_high.mp4 (GET)

1280x720p 30fps 5Mbit Stream.A 1280x720p 30fps 5Mbit stream.

live_med.mp4/АПИ/холографик/стреам/(GET)/api/holographic/stream/live_med.mp4 (GET)

Поток 854x480p 30fps 2.5 Мбит.A 854x480p 30fps 2.5Mbit stream.

live_low.mp4/АПИ/холографик/стреам/(GET)/api/holographic/stream/live_low.mp4 (GET)

Поток 428x240p 15fps 0,6 Мбит.A 428x240p 15fps 0.6Mbit stream.

СетьNetworking

/АПИ/нетворкинг/ипконфиг (GET)/api/networking/ipconfig (GET)

Возвращает текущую IP-конфигурациюGets the current ip configuration

Сведения о ОСOS Information

/АПИ/ОС/Инфо (GET)/api/os/info (GET)

Получение сведений об операционной системеGets operating system information

/АПИ/ОС/мачиненаме (GET)/api/os/machinename (GET)

Возвращает имя компьютера.Gets the machine name

/АПИ/ОС/мачиненаме (POST)/api/os/machinename (POST)

Задает имя компьютераSets the machine name

ПараметрыParameters

  • Имя: новое имя компьютера, hex64 в кодировке, для которого задано значение.name : New machine name, hex64 encoded, to set to

Элемент управления имитацией восприятияPerception Simulation Control

/АПИ/холографик/симулатион/контрол/моде (GET)/api/holographic/simulation/control/mode (GET)

Получение режима моделированияGet the simulation 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 (DELETE)

Удаляет поток управления.Delete a control stream.

/АПИ/холографик/симулатион/контрол/стреам (GET/WebSocket)/api/holographic/simulation/control/stream (GET/WebSocket)

Откройте подключение к веб-сокету для потока управления.Open a web socket connection for a control stream.

/АПИ/холографик/симулатион/контрол/стреам (POST)/api/holographic/simulation/control/stream (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'.

/АПИ/холографик/симулатион/дисплай/стреам (GET/WebSocket)/api/holographic/simulation/display/stream (GET/WebSocket)

Запросите поток видео имитации, содержащий содержимое, отображаемое для отображения в системе, в режиме "имитация".Request a simulation video stream containing the content rendered to the system display when in 'Simulation' mode. Сначала будет отправлен заголовок простого дескриптора формата, а затем H. 264-Encoded текстуры, в каждой из которых предшествует заголовок, указывающий индекс глаза и размер текстуры.A simple format descriptor header will be sent initially, followed by H.264-encoded textures, each preceded by a header indicating the eye index and texture size.

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

/АПИ/холографик/симулатион/плайбакк/филе (удаление)/api/holographic/simulation/playback/file (DELETE)

Удаление записи.Delete a recording.

ПараметрыParameters

  • запись: имя записи для удаления.recording : Name of recording to delete.

/АПИ/холографик/симулатион/плайбакк/филе (POST)/api/holographic/simulation/playback/file (POST)

Отправьте запись.Upload a recording.

/АПИ/холографик/симулатион/плайбакк/Филес (GET)/api/holographic/simulation/playback/files (GET)

Получение всех записей.Get all recordings.

/АПИ/холографик/симулатион/плайбакк/Сессион (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 (DELETE)

Выгрузить запись.Unload a recording.

ПараметрыParameters

  • запись: имя записи для выгрузки.recording : Name of recording to unload.

/АПИ/холографик/симулатион/плайбакк/Сессион/филе (POST)/api/holographic/simulation/playback/session/file (POST)

Загрузка записи.Load a recording.

ПараметрыParameters

  • запись: имя загружаемой записи.recording : Name of recording to load.

/АПИ/холографик/симулатион/плайбакк/Сессион/Филес (GET)/api/holographic/simulation/playback/session/files (GET)

Получение всех загруженных записей.Get all loaded recordings.

/АПИ/холографик/симулатион/плайбакк/Сессион/паусе (POST)/api/holographic/simulation/playback/session/pause (POST)

Приостановка записи.Pause a recording.

ПараметрыParameters

  • запись: имя записи.recording : Name of recording.

/АПИ/холографик/симулатион/плайбакк/Сессион/Плай (POST)/api/holographic/simulation/playback/session/play (POST)

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

ПараметрыParameters

  • запись: имя записи.recording : Name of recording.

/АПИ/холографик/симулатион/плайбакк/Сессион/стоп (POST)/api/holographic/simulation/playback/session/stop (POST)

Останавливает запись.Stop a recording.

ПараметрыParameters

  • запись: имя записи.recording : Name of recording.

/АПИ/холографик/симулатион/плайбакк/Сессион/типес (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

/АПИ/холографик/симулатион/рекординг/старт (POST)/api/holographic/simulation/recording/start (POST)

Начать запись.Start a recording. Одновременно может быть активна только одна запись.Only a single recording can be active at once. Необходимо задать один из головок, «руки», «Спатиалмаппинг» или «среда».One of head, hands, spatialMapping or environment must be set.

ПараметрыParameters

  • Head: задайте значение 1, чтобы записать данные заголовка.head : Set to 1 to record head data.
  • стрелки: значение 1, чтобы записать данные.hands : Set to 1 to record hand data.
  • Спатиалмаппинг: задайте значение 1 для записи пространственного сопоставления.spatialMapping : Set to 1 to record spatial mapping.
  • окружение: задайте значение 1, чтобы записать данные среды.environment : Set to 1 to record environment data.
  • имя. имя записи.name : Name of the recording.
  • Синглеспатиалмаппингфраме: задайте значение 1, чтобы записать только один фрейм пространственного сопоставления.singleSpatialMappingFrame : Set to 1 to record only a single spatial mapping frame.

/АПИ/холографик/симулатион/рекординг/статус (GET)/api/holographic/simulation/recording/status (GET)

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

/АПИ/холографик/симулатион/рекординг/стоп (GET)/api/holographic/simulation/recording/stop (GET)

Останавливает текущую запись.Stop the current recording. Запись будет возвращена в виде файла.Recording will be returned as a file.

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

/АПИ/ресаурцеманажер/процессес (GET)/api/resourcemanager/processes (GET)

Возвращает список запущенных процессов с подробными сведениямиReturns the list of running processes with details

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

  • JSON со списком процессов и сведений для каждого процессаJSON with list of processes and details for each process

/АПИ/ресаурцеманажер/системперф (GET)/api/resourcemanager/systemperf (GET)

Возвращает статистику производительности системы (операции чтения и записи ввода-вывода, статистика памяти и т. д.).Returns system perf statistics (I/O read/write, memory stats etc.

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

  • JSON со сведениями о системе: ЦП, GPU, память, сеть, IOJSON with system information: CPU, GPU, Memory, Network, IO

ПитаниеPower

/АПИ/повер/Баттери (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

/АПИ/контрол/рестарт (POST)/api/control/restart (POST)

Перезапускает целевое устройствоRestarts the target device

/АПИ/контрол/шутдовн (POST)/api/control/shutdown (POST)

Завершает работу целевого устройстваShuts down the target device

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

/АПИ/таскманажер/АПП (удаление)/api/taskmanager/app (DELETE)

Останавливает современное приложениеStops a modern app

ПараметрыParameters

  • Package: полное имя пакета приложения, hex64 в кодировкеpackage : Full name of the app package, hex64 encoded
  • форцестоп: принудительно останавливаются все процессы (= да)forcestop : Force all processes to stop (=yes)

/АПИ/таскманажер/АПП (POST)/api/taskmanager/app (POST)

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

ПараметрыParameters

  • AppID: ПРАИД приложения для запуска, hex64 в кодировкеappid : PRAID of app to start, hex64 encoded
  • Package: полное имя пакета приложения, hex64 в кодировкеpackage : Full name of the app package, hex64 encoded

Управление Wi-FiWiFi Management

/АПИ/ВИФИ/интерфацес (GET)/api/wifi/interfaces (GET)

Перечисляет беспроводные сетевые интерфейсыEnumerates wireless network interfaces

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

  • Список беспроводных интерфейсов с подробными сведениями (GUID, описание и т. д.).List of wireless interfaces with details (GUID, description etc.)

/АПИ/ВИФИ/Нетворк (удаление)/api/wifi/network (DELETE)

Удаление профиля, связанного с сетью, в указанном интерфейсеDeletes a profile associated with a network on a specified interface

ПараметрыParameters

  • интерфейс: GUID сетевого интерфейсаinterface : network interface guid
  • Профиль: имя профиляprofile : profile name

/АПИ/ВИФИ/Нетворкс (GET)/api/wifi/networks (GET)

Перечисляет беспроводные сети в указанном сетевом интерфейсеEnumerates wireless networks on the specified network interface

ПараметрыParameters

  • интерфейс: GUID сетевого интерфейсаinterface : network interface guid

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

  • Список беспроводных сетей, обнаруженных в сетевом интерфейсе, с подробными сведениямиList of wireless networks found on the network interface with details

/АПИ/ВИФИ/Нетворк (POST)/api/wifi/network (POST)

Подключение к сети или отключение от него по указанному интерфейсуConnects or disconnects to a network on the specified interface

ПараметрыParameters

  • интерфейс: GUID сетевого интерфейсаinterface : network interface guid
  • SSID: SSID, hex64 в кодировке для подключенияssid : ssid, hex64 encoded, to connect to
  • Операция: подключение или отключениеop : connect or disconnect
  • креатепрофиле: Да или нетcreateprofile : yes or no
  • ключ: Shared Key, hex64 Encodedkey : shared key, hex64 encoded

Средство записи производительности WindowsWindows Performance Recorder

/АПИ/ВПР/кустомтраце (POST)/api/wpr/customtrace (POST)

Отправляет профиль ЗВЧ и начинает трассировку с помощью отправленного профиля.Uploads a WPR profile and starts tracing using the uploaded profile.

PayloadPayload

  • текст HTTP из нескольких частейmulti-part conforming http body

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

  • Возвращает состояние сеанса ЗВЧ.Returns the WPR session status.

/АПИ/ВПР/статус (GET)/api/wpr/status (GET)

Получение состояния сеанса ЗВЧRetrieves the status of the WPR session

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

  • Состояние сеанса ЗВЧ.WPR session status.

/АПИ/ВПР/траце (GET)/api/wpr/trace (GET)

Останавливает сеанс трассировки ЗВЧ (производительность)Stops a WPR (performance) tracing session

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

  • Возвращает ETL-файл трассировкиReturns the trace ETL file

/АПИ/ВПР/траце (POST)/api/wpr/trace (POST)

Запускает сеансы трассировки ЗВЧ (производительность)Starts a WPR (performance) tracing sessions

ПараметрыParameters

  • Профиль: имя профиля.profile : Profile name. Доступные профили хранятся в перфпрофилес/profiles.jsнаAvailable profiles are stored in perfprofiles/profiles.json

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

  • При запуске возвращает состояние сеанса ЗВЧ.On start, returns the WPR session status.

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