狀態

/osc/state API 會傳回相機的 state 屬性。差異 在這個 API 和 info API 之間,state 包含可變動值 代表攝影機狀態 (例如 batteryLevel),info 僅包含相機的靜態屬性 (例如,manufacturer 或 不會經常變更的屬性 (例如 firmwareVersion))。

輸入

  • 這個指令不接收任何輸入內容,

輸出

名稱 類型 說明
fingerprint 字串 目前相機狀態的指紋 (專屬 ID)。
state 物件 包含各種相機狀態狀態的 JSON 物件。請參閱下一個表格。

state 個物件

這個 JSON 物件提供各種相機狀態的狀態。製造商 提供新的自訂狀態,開頭應加上底線 ( _ ) 可以防止命名空間衝突

名稱 類型 說明
sessionId 字串 目前工作階段的 ID。這個欄位已在 API 級別 2 中淘汰。
batteryLevel 數字 以電池剩餘電量的浮點值表示,例如:0.5 版
storageChanged 布林值 如果插入/移除新型儲存空間 (例如 SD 卡或 USB 隨身碟),則為 True。 這個欄位已在 API 級別 2 中淘汰。
storageUri 字串 用於區分不同儲存空間的專屬 ID。用於判斷儲存空間是否已變更。 這是在 API 級別 2 中新增的欄位。
_vendorSpecific [類型](選用) 供應商專屬的相機其他狀態。請在前置字元加上底線 ( _ ),避免命名空間衝突。

錯誤

  • 這個指令不會傳回任何錯誤。

範例

要求
POST /osc/state HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
回應
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
    "fingerprint": "12EGA33",
    "state": {
        "sessionId": "12ABC3",
        "batteryLevel": 0.5,
        "storageChanged": false
    }
}