适用于 HoloLens 的 Device Portal API 参考Device Portal API reference for HoloLens

Windows Device Portal 中的所有内容都是基于 REST API 创建的,该 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.

全息操作系统Holographic OS

获取 Device Portal 的 HTTPS 要求Get HTTPS requirements for the Device Portal

请求Request

可以通过使用以下请求格式来获取 Device Portal 的 HTTPS 要求。You can get the HTTPS requirements for the Device Portal by using the following request format.

方法Method 请求 URIRequest 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 请求 URIRequest 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.

获取 HoloLens 特定的 ETW 提供程序列表Get a list of HoloLens specific ETW providers

请求Request

可以通过使用以下请求格式来获取未向系统注册的 HoloLens 特定的 ETW 提供程序列表。You can get a list of HoloLens specific ETW providers that are not registered with the system by using the following request format.

方法Method 请求 URIRequest 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 请求 URIRequest 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.

设置 Device Portal 的 HTTPS 要求。Set the HTTPS requirement for the Device Portal.

请求Request

可以通过使用以下请求格式来设置 Device Portal 的 HTTPS 要求。You can set the HTTPS requirements for the Device Portal by using the following request format.

方法Method 请求 URIRequest 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 必需)确定 Device Portal 是否需要 HTTPS。(required) Determines whether or not HTTPS is required for the Device Portal. 可能的值包括 yesnodefaultPossible 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 请求 URIRequest 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

接受 WebSocket 升级并运行发送更新的虚拟客户端Accept websocket upgrades and run a mirage client that sends updates

请求Request

可以通过使用以下请求格式来接受 WebSocket 升级,并运行以 30 帧/秒的速度发送更新的虚拟客户端。You can accept websocket upgrades and run a mirage client that sends updates at 30 fps by using the following request format.

方法Method 请求 URIRequest 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. 视觉跟踪模式无法被动建立时,值为 active 会强制执行该模式。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 请求 URIRequest 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.

HSimulation 控制HSimulation 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 请求 URIRequest 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 请求 URIRequest 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

可以通过使用以下请求格式来打开用于控制流的 Web 套接字连接。You can open a web socket connection for a control stream by using the following request format.

方法Method 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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. 可能的值包括 defaultsimulationremotelegacyPossible values include default, simulation, remote, and legacy.

请求标头Request headers

  • None

请求正文Request body

  • None

响应Response

  • None

状态代码Status code

  • 标准状态代码。Standard status codes.

HSimulation 播放HSimulation playback

删除录制Delete a recording

请求Request

可以通过使用以下请求格式来删除录制。You can delete a recording by using the following request format.

方法Method 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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.

HSimulation 录制HSimulation recording

获取录制状态Get the recording state

请求Request

可以通过使用以下请求格式来获取当前的录制状态。You can get the current recording state by using the following request format.

方法Method 请求 URIRequest 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 请求 URIRequest 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
headhead 如下所示)将此值设置为 1,以指示系统应记录头数据。(see below) Set this value to 1 to indicate the system should record head data.
handshands 如下所示)将此值设置为 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.
environmentenvironment 如下所示)将此值设置为 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:headhandsspatialMappingenvironmentFor 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 请求 URIRequest 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 请求 URIRequest 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
filenamefilename 必需)要删除的视频文件名称。(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 请求 URIRequest 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
filenamefilename 必需)要获取的视频文件名称。(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 请求 URIRequest 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. 可能的值包括 runningstoppedThe possible values include running and stopped.

方法Method 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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 请求 URIRequest 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

启动碎片 mp4 的分块下载Initiates 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 请求 URIRequest 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 可选)指示是否捕获 PV 相机。(optional) Indiates whether to capture the PV camera. 应为 truefalseShould be true or false.
holoholo 可选)指示是否捕获全息图。(optional) Indiates whether to capture holograms. 应为 truefalseShould be true or false.
micmic 可选)指示是否捕获麦克风。(optional) Indiates whether to capture the microphone. 应为 truefalseShould be true or false.
loopbackloopback 可选)指示是否捕获应用程序音频。(optional) Indiates whether to capture the application audio. 应为 truefalseShould be true or false.

请求标头Request headers

  • None

请求正文Request body

  • None

响应Response

  • None

状态代码Status code

  • 标准状态代码。Standard status codes.

启动碎片 mp4 的分块下载Initiates 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 请求 URIRequest 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 可选)指示是否捕获 PV 相机。(optional) Indiates whether to capture the PV camera. 应为 truefalseShould be true or false.
holoholo 可选)指示是否捕获全息图。(optional) Indiates whether to capture holograms. 应为 truefalseShould be true or false.
micmic 可选)指示是否捕获麦克风。(optional) Indiates whether to capture the microphone. 应为 truefalseShould be true or false.
loopbackloopback 可选)指示是否捕获应用程序音频。(optional) Indiates whether to capture the application audio. 应为 truefalseShould be true or false.

请求标头Request headers

  • None

请求正文Request body

  • None

响应Response

  • None

状态代码Status code

  • 标准状态代码。Standard status codes.

启动碎片 mp4 的分块下载Initiates 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 请求 URIRequest 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 可选)指示是否捕获 PV 相机。(optional) Indiates whether to capture the PV camera. 应为 truefalseShould be true or false.
holoholo 可选)指示是否捕获全息图。(optional) Indiates whether to capture holograms. 应为 truefalseShould be true or false.
micmic 可选)指示是否捕获麦克风。(optional) Indiates whether to capture the microphone. 应为 truefalseShould be true or false.
loopbackloopback 可选)指示是否捕获应用程序音频。(optional) Indiates whether to capture the application audio. 应为 truefalseShould be true or false.

请求标头Request headers

  • None

请求正文Request body

  • None

响应Response

  • None

状态代码Status code

  • 标准状态代码。Standard status codes.

启动碎片 mp4 的分块下载Initiates 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 请求 URIRequest 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 可选)指示是否捕获 PV 相机。(optional) Indiates whether to capture the PV camera. 应为 truefalseShould be true or false.
holoholo 可选)指示是否捕获全息图。(optional) Indiates whether to capture holograms. 应为 truefalseShould be true or false.
micmic 可选)指示是否捕获麦克风。(optional) Indiates whether to capture the microphone. 应为 truefalseShould be true or false.
loopbackloopback 可选)指示是否捕获应用程序音频。(optional) Indiates whether to capture the application audio. 应为 truefalseShould be true or false.

请求标头Request headers

  • None

请求正文Request body

  • None

响应Response

  • None

状态代码Status code

  • 标准状态代码。Standard status codes.