HoloLens 的 Device Portal API 參考Device Portal API reference for HoloLens

Windows Device Portal 中的所有項目都是以 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.

全像攝影版 OSHolographic 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 (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 (required) 要儲存的新 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 升級並執行傳送更新的 Mirage 用戶端Accept websocket upgrades and run a mirage client that sends updates

要求Request

您可以透過使用下列要求格式,以接受 WebSocket 升級,並執行以 30 fps 傳送更新的 Mirage 用戶端。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
優先順序priority (建立控制項串流時為必要) 指出串流的優先順序。(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

您可以透過使用下列要求格式,為控制項串流開啟網路通訊端連線。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.