Справка по API Портала устройства для HoloLensDevice Portal API reference for HoloLens

Весь портал устройств Windows построен на API-интерфейсах REST, которые можно использовать для получения доступа к данным и программного управления устройством.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.

Holographic OSHolographic OS

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

ЗапросRequest

Вы можете получить требования HTTPS для Портала устройства, придерживаясь следующего формата запроса.You can get the HTTPS requirements for the Device Portal by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/os/webmanagement/settings/https/api/holographic/os/webmanagement/settings/https

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение сохраненного межзрачкового расстояния (IPD)Get the stored interpupillary distance (IPD)

ЗапросRequest

Вы можете получить сохраненное значение IPD, придерживаясь следующего формата запроса.You can get the stored IPD value by using the following request format. Значение возвращается в миллиметрах.The value is returned in millimeters.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение списка определенных поставщиков трассировки событий Windows для HoloLensGet a list of HoloLens specific ETW providers

ЗапросRequest

Вы можете получить список определенных поставщиков трассировки событий Windows для HoloLens, которые не зарегистрированы в системе, придерживаясь следующего формата запроса.You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/os/etw/customproviders/api/holographic/os/etw/customproviders

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Возврат состояния всех активных службReturn the state for all active services

ЗапросRequest

Вы можете получить состояние всех служб, которые работают в настоящее время, придерживаясь следующего формата запроса.You can get the state of all services that are currently running by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/os/services/api/holographic/os/services

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Задайте требование HTTPS для Портала устройств.Set the HTTPS requirement for the Device Portal.

ЗапросRequest

Вы можете задать требования HTTPS для Портала устройства, придерживаясь следующего формата запроса.You can set the HTTPS requirements for the Device Portal by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/management/settings/https/api/holographic/management/settings/https

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
обязательныеrequired (необходимый) определяет, необходимо ли HTTPS для Портала устройств.(required) Determines whether or not HTTPS is required for the Device Portal. Возможные значения: да, нет и по умолчанию.Possible values are yes, no, and default.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Определение межзрачкового расстояния (IPD)Set the interpupillary distance (IPD)

ЗапросRequest

Вы можете задать сохраненное значение IPD, придерживаясь следующего формата запроса.You can set the stored IPD by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/os/settings/ipd/api/holographic/os/settings/ipd

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
ipdipd (необходимое) Будет сохранено новое значение IPD.(required) The new IPD value to be stored. Это значение должно быть указано в миллиметрах.This value should be in millimeters.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

Принятие обновлений веб-сокета и запуск миражного клиента для отправки обновленийAccept websocket upgrades and run a mirage client that sends updates

ЗапросRequest

Вы можете принять обновления веб-сокета и запустить миражного клиента, который отправляет обновления со скоростью 30 кадров/с, придерживаясь следующего формата запроса.You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GET/WebSocketGET/WebSocket /api/holographic/perception/client/api/holographic/perception/client

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
clientmodeclientmode (необходимый) Определяет режим отслеживания.(required) Determines the tracking mode. Значение активный принудительно применяет режим отслеживания, если его невозможно установить пассивно.A value of active forces visual tracking mode when it can't be established passively.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Голографическая температураHolographic thermal

Получение температурной стадии устройстваGet the thermal stage of the device

ЗапросRequest

Вы можете получить температурную стадию устройства, придерживаясь следующего формата запроса.You can get the thermal stage of the device by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic//api/holographic/

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Возможные значения приведены в следующей таблице.The possible values are indicated by the following table.

ЗначениеValue ОписаниеDescription
11 ОбычныйNormal
22 СреднийWarm
33 КритическоеCritical

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Управление HSimulationHSimulation control

Создание контрольного потока или публикация данных в созданном потокеCreate a control stream or post data to a created stream

ЗапросRequest

Вы можете создать контрольный поток или публиковать данные в созданный поток, придерживаясь следующего формата запроса.You can create a control stream or post data to a created stream by using the following request format. Опубликованные данные должны иметь тип application/octet-stream.The posted data is expected to be of type application/octet-stream.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
prioritypriority (требуется при создании контрольного потока) Указывает приоритет потока.(required if creating a control stream) Indicates the priority of the stream.
streamidstreamid (требуется при публикации в созданном потоке) Идентификатор потока для публикации.(required if posting to a created stream) The identifier for the stream to post to.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Удаление контрольного потокаDelete a control stream

ЗапросRequest

Вы можете удалить контрольный поток, придерживаясь следующего формата запроса.You can delete a control stream by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение контрольного потокаGet a control stream

ЗапросRequest

Вы можете открыть подключение к веб-сокету для контрольного потока, придерживаясь следующего формата запроса.You can open a web socket connection for a control stream by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GET/WebSocketGET/WebSocket /api/holographic/simulation/control/stream/api/holographic/simulation/control/stream

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение режима имитацииGet the simulation mode

ЗапросRequest

Вы можете получить режим симуляторов, придерживаясь следующего формата запроса.You can get the simluation mode by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/control/mode/api/holographic/simulation/control/mode

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Установка режима имитацииSet the simulation mode

ЗапросRequest

Вы можете задать режим симуляторов, придерживаясь следующего формата запроса.You can set the simulation mode by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simluation/control/mode/api/holographic/simluation/control/mode

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
modemode (необходимый) Указывает режим симуляторов.(required) Indicates the simulation mode. Возможные значения включают по умолчанию, симуляторы, удаленный и устаревший.Possible values include default, simulation, remote, and legacy.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Воспроизведение HSimulationHSimulation playback

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

ЗапросRequest

Вы можете удалить запись, используя следующий формат запроса.You can delete a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для удаления.(required) The name of the recording to delete.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

ЗапросRequest

Вы можете получить все доступные записи, придерживаясь следующего формата запросов.You can get all the available recordings by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/playback/files/api/holographic/simulation/playback/files

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение типов данных в загруженной записиGet the types of data in a loaded recording

ЗапросRequest

Вы можете получить типы данных в загруженной записи, придерживаясь следующего формата запроса.You can get the types of data in a loaded recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/playback/session/types/api/holographic/simulation/playback/session/types

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя интересующей вас записи.(required) The name of the recording you are interested in.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

ЗапросRequest

Вы можете получить все загруженные записи, придерживаясь следующего формата запросов.You can get all the loaded recordings by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/playback/session/files/api/holographic/simulation/playback/session/files

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение текущего состояния воспроизведения записиGet the current playback state of a recording

ЗапросRequest

Вы можете получить текущее состояние воспроизведения записи, используя следующий формат запроса.You can get the current playback state of a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/playback/session/api/holographic/simulation/playback/session

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя интересующей вас записи.(required) The name of the recording that you are interested in.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

ЗапросRequest

Вы можете загрузить запись, используя следующий формат запроса.You can load a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для загрузки.(required) The name of the recording to load.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

ЗапросRequest

Вы можете приостановить запись, используя следующий формат запроса.You can pause a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/playback/session/pause/api/holographic/simulation/playback/session/pause

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для приостановки.(required) The name of the recording to pause.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

ЗапросRequest

Вы можете воспроизвести запись, используя следующий формат запроса.You can play a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/playback/session/play/api/holographic/simulation/playback/session/play

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для воспроизведения.(required) The name of the recording to play.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Остановка записиStop a recording

ЗапросRequest

Вы можете остановить запись, используя следующий формат запроса.You can stop a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/playback/session/stop/api/holographic/simulation/playback/session/stop

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для остановки.(required) The name of the recording to stop.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Выгрузка записиUnload a recording

ЗапросRequest

Вы можете выгрузить запись, используя следующий формат запроса.You can unload a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/holographic/simulation/playback/session/file/api/holographic/simulation/playback/session/file

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
записьrecording (необходимый) Имя записи для выгрузки.(required) The name of the recording to unload.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Передача записиUpload a recording

ЗапросRequest

Вы можете передать запись, используя следующий формат запроса.You can upload a recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/playback/file/api/holographic/simulation/playback/file

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Запись HSimulationHSimulation recording

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

ЗапросRequest

Вы можете получить текущее состояние записи, используя следующий формат запроса.You can get the current recording state by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/simulation/recording/status/api/holographic/simulation/recording/status

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Начало записиStart a recording

ЗапросRequest

Вы можете начать запись, используя следующий формат запроса.You can start a recording by using the following request format. Одновременно может быть активной только одна запись.There can only be one active recording at a time.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/recording/start/api/holographic/simulation/recording/start

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
головаhead (см. ниже) Установите это значение, равным 1, для указания необходимости записи системой данных головы.(see below) Set this value to 1 to indicate the system should record head data.
рукиhands (см. ниже) Установите это значение, равным 1, для указания необходимости записи системой данных рук.(see below) Set this value to 1 to indicate the system should record hands data.
spatialMappingspatialMapping (см. ниже) Установите для этого параметра значение 1, чтобы указать, что система должна записывать данные пространственного сопоставления.(see below) Set this value to 1 to indicate the system should record spatial mapping data.
средаenvironment (см. ниже) Установите для этого параметра значение 1, чтобы указать необходимость записи системой данных среды.(see below) Set this value to 1 to indicate the system should record environment data.
namename (необходимый) Имя записи.(required) The name of the recording.
singleSpatialMappingFramesingleSpatialMappingFrame (необязательный) Установите для этого параметра значение 1, чтобы указать на возможность записи только одного кадра пространственного сопоставления.(optional) Set this value to 1 to indicate that only a single sptial mapping frame should be recorded.

Для этих параметров только один из следующих параметров должен быть равен 1: голова, руки, spatialMapping или среда.For these parameters, exactly one of the following parameters must be set to 1: head, hands, spatialMapping, or environment.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Остановка текущей записиStop the current recording

ЗапросRequest

Вы можете остановить текущую запись, используя следующий формат запроса.You can stop the current recording by using the following request format. Запись будет возвращена как файл.The recording will be returned as a file.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/simulation/recording/stop/api/holographic/simulation/recording/stop

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

Удаление записи смешанного захвата реальности (MRC) реальности с устройстваDelete a mixed reality capture (MRC) recording from the device

ЗапросRequest

Вы можете удалить запись MRC, используя следующий формат запроса.You can delete an MRC recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/holographic/mrc/file/api/holographic/mrc/file

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
имя_файлаfilename (необходимый) Имя удаляемого видеофайла.(required) The name of the video file to delete. Имя должно быть в кодировке hex64.The name should be hex64 encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Загрузка файла смешанного захвата реальности (MRC)Download a mixed reality capture (MRC) file

ЗапросRequest

Можно загрузить файл MRC с устройства, используя следующий формат запроса.You can download an MRC file from the device by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/mrc/file/api/holographic/mrc/file

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
имя_файлаfilename (необходимый) Имя видеофайла, который необходимо получить.(required) The name of the video file you want to get. Имя должно быть в кодировке hex64.The name should be hex64 encoded.
opop (необязательный) Задайте для этого параметра значение stream, если необходимо загрузить поток.(optional) Set this value to stream if you want to download a stream.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение параметров смешанного захвата реальности (MRC)Get the mixed reality capture (MRC) settings

ЗапросRequest

Вы можете получить параметры MRC, придерживаясь следующего формата запроса.You can get the MRC settings by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/mrc/settings/api/holographic/mrc/settings

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение состояния записи смешанного захвата реальности (MRC)Get the status of the mixed reality capture (MRC) recording

ЗапросRequest

Вы можете получить сведения о состоянии записи MRC с помощью следующего формата запросов.You can get the MRC recording status by using the following request format. Возможные значения включают выполняется и остановлено.The possible values include running and stopped.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/mrc/status/api/holographic/mrc/status

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Получение списка файлов смешанного захвата реальности (MRC)Get the list of mixed reality capture (MRC) files

ЗапросRequest

Вы можете получить доступ к файлам MRC, хранящимся на устройстве, используя следующий формат запроса.You can get the MRC files stored on the device by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/mrc/files/api/holographic/mrc/files

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Определение параметров смешанного захвата реальности (MRC)Set the mixed reality capture (MRC) settings

ЗапросRequest

Вы можете определить параметры MRC, придерживаясь следующего формата запроса.You can set the MRC settings by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/mrc/settings/api/holographic/mrc/settings

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Запуск записи смешанного захвата реальности (MRC)Starts a mixed reality capture (MRC) recording

ЗапросRequest

Вы можете начать запись MRC, используя следующий формат запроса.You can start an MRC recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/mrc/video/control/start/api/holographic/mrc/video/control/start

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Остановка текущей записи смешанного захвата реальности (MRC)Stop the current mixed reality capture (MRC) recording

ЗапросRequest

Вы можете остановить текущую запись MRC, используя следующий формат запроса.You can stop the current MRC recording by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/holographic/mrc/video/control/stop/api/holographic/mrc/video/control/stop

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Снимок смешанного захвата реальности (MRC)Take a mixed reality capture (MRC) photo

ЗапросRequest

Вы можете сделать снимок MRC с помощью следующего формата запроса.You can take an MRC photo by using the following request format. Фотография возвращается в формате JPEG.The photo is returned in JPEG format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/mrc/photo/api/holographic/mrc/photo

Параметры универсального кода ресурса (URI)URI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

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

Инициализация поблочной загрузки фрагментированного файла MP4Initiates a chunked download of a fragmented mp4

ЗапросRequest

Вы можете инициировать поблочную загрузку фрагментированного файла MP4, используя следующий формат запроса.You can initiate a chunked download of a fragmented mp4 by using the following request format. Этот API использует качество по умолчанию.This API uses the default quality.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/stream/live.mp4/api/holographic/stream/live.mp4

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pvpv (необязательный) Указывает, следует ли захватывать данные с фото/видеокамеры.(optional) Indiates whether to capture the PV camera. Должно быть true или false.Should be true or false.
holoholo (необязательный) Указывает, следует ли захватывать голограммы.(optional) Indiates whether to capture holograms. Должно быть true или false.Should be true or false.
micmic (необязательный) Указывает, следует ли захватывать данные с микрофона.(optional) Indiates whether to capture the microphone. Должно быть true или false.Should be true or false.
замыкание на себяloopback (необязательный) Указывает, следует ли захватывать аудио из приложения.(optional) Indiates whether to capture the application audio. Должно быть true или false.Should be true or false.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Инициализация поблочной загрузки фрагментированного файла MP4Initiates a chunked download of a fragmented mp4

ЗапросRequest

Вы можете инициировать поблочную загрузку фрагментированного файла MP4, используя следующий формат запроса.You can initiate a chunked download of a fragmented mp4 by using the following request format. Этот интерфейс API использует высокое качество.This API uses the high quality.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/stream/live_high.mp4/api/holographic/stream/live_high.mp4

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pvpv (необязательный) Указывает, следует ли захватывать данные с фото/видеокамеры.(optional) Indiates whether to capture the PV camera. Должно быть true или false.Should be true or false.
holoholo (необязательный) Указывает, следует ли захватывать голограммы.(optional) Indiates whether to capture holograms. Должно быть true или false.Should be true or false.
micmic (необязательный) Указывает, следует ли захватывать данные с микрофона.(optional) Indiates whether to capture the microphone. Должно быть true или false.Should be true or false.
замыкание на себяloopback (необязательный) Указывает, следует ли захватывать аудио из приложения.(optional) Indiates whether to capture the application audio. Должно быть true или false.Should be true or false.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Инициализация поблочной загрузки фрагментированного файла MP4Initiates a chunked download of a fragmented mp4

ЗапросRequest

Вы можете инициировать поблочную загрузку фрагментированного файла MP4, используя следующий формат запроса.You can initiate a chunked download of a fragmented mp4 by using the following request format. Этот интерфейс API использует низкое качество.This API uses the low quality.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/stream/live_low.mp4/api/holographic/stream/live_low.mp4

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pvpv (необязательный) Указывает, следует ли захватывать данные с фото/видеокамеры.(optional) Indiates whether to capture the PV camera. Должно быть true или false.Should be true or false.
holoholo (необязательный) Указывает, следует ли захватывать голограммы.(optional) Indiates whether to capture holograms. Должно быть true или false.Should be true or false.
micmic (необязательный) Указывает, следует ли захватывать данные с микрофона.(optional) Indiates whether to capture the microphone. Должно быть true или false.Should be true or false.
замыкание на себяloopback (необязательный) Указывает, следует ли захватывать аудио из приложения.(optional) Indiates whether to capture the application audio. Должно быть true или false.Should be true or false.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Инициализация поблочной загрузки фрагментированного файла MP4Initiates a chunked download of a fragmented mp4

ЗапросRequest

Вы можете инициировать поблочную загрузку фрагментированного файла MP4, используя следующий формат запроса.You can initiate a chunked download of a fragmented mp4 by using the following request format. Этот интерфейс API использует среднее качество.This API uses the medium quality.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/holographic/stream/live_med.mp4/api/holographic/stream/live_med.mp4

Параметры универсального кода ресурса (URI)URI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pvpv (необязательный) Указывает, следует ли захватывать данные с фото/видеокамеры.(optional) Indiates whether to capture the PV camera. Должно быть true или false.Should be true or false.
holoholo (необязательный) Указывает, следует ли захватывать голограммы.(optional) Indiates whether to capture holograms. Должно быть true или false.Should be true or false.
micmic (необязательный) Указывает, следует ли захватывать данные с микрофона.(optional) Indiates whether to capture the microphone. Должно быть true или false.Should be true or false.
замыкание на себяloopback (необязательный) Указывает, следует ли захватывать аудио из приложения.(optional) Indiates whether to capture the application audio. Должно быть true или false.Should be true or false.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.