/osc/state
API 會傳回相機的 state
屬性。 這與 info
API 之間的不同在於,state
包含代表相機狀態的可變值(例如 batteryLevel
),而 info
只包含相機的靜態屬性(例如,manufacturer
或不常變更的屬性,如 firmwareVersion)
。
輸入
- 此命令不接受輸入。
輸出
名稱 | 類型 | 描述 |
---|---|---|
fingerprint |
字串 | 目前相機狀態的指紋(唯一識別碼)。 |
state |
物件 | 包含不同相機狀態的 JSON 物件。 請參閱後續表格。 |
state
物件
此 JSON 物件提供不同的相機狀態。 製造商可以提供新的自訂狀態,而且前面應加上底線 ( _ ) 以避免命名空間衝突。
名稱 | 類型 | 描述 |
---|---|---|
sessionId |
字串 | 目前工作階段的 ID。 此欄位在 API 級別 2 中已淘汰。 |
batteryLevel |
數字 | 以浮點數值表示的剩餘電力,例如 0.5 |
storageChanged |
布林值 | True,如果新類型的存放裝置(例如, SD 卡或 USB 磁碟機) 已插入/已移除。 此欄位在 API 級別 2 中已淘汰。 |
storageUri |
字串 | 區分不同儲存空間的唯一識別碼。 用來辨識儲存空間是否變更。 此欄位已在 API 級別 2 中新增。 |
_vendorSpecific |
[類型](optional) | 廠商專用的其他相機狀態。 前面應加上底線 ( _ ),以避免命名空間衝突。 |
錯誤
- 此命令不會傳回錯誤。
範例 |
|
---|---|
要求 | 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 } } |