/osc/info
API 會傳回有關所支援相機與功能的基本資訊。
輸入
輸出
名稱
| 類型
| 描述
|
manufacturer |
字串 |
相機製造商。 |
model |
字串 |
相機的機型。 |
serialNumber |
字串 |
序號。 |
firmwareVersion |
字串 |
目前的韌體版本。 |
supportUrl |
字串 |
相機的支援網頁 URL。 |
gps |
布林值 |
如果相機有 GPS,則為 True。 |
gyro |
布林值 |
如果相機有陀螺儀,則為 True。 |
uptime |
整數 |
相機開機所花的秒數。 |
api |
字串陣列 |
支援的 API 清單。 |
endpoints |
物件 |
包含相機端點相關資訊的 JSON 物件。 請參閱後續表格。 |
apiLevel |
整數陣列 |
當此欄位遺失時,預設值為 [1]。 [1, 2] 表示支援 API 1 與 2,而 [2] 則表示僅支援 API 2。 擷取此資訊並根據該值以不同方式實作,是開發人員的責任。 此欄位已在 API 級別 2 中新增。 |
_vendorSpecific |
[類型](選擇性) |
廠商專用的其他相機資訊。 請在廠商專用金鑰前面應加上底線 ( _ ),以避免命名空間衝突。 |
endpoints
物件
此 JSON 物件提供相機供端點使用的連接埠相關資訊。
名稱
| 類型
| 描述
|
httpPort |
整數 |
供 HTTP 伺服器使用的連接埠。 (預設值 80) |
httpUpdatesPort |
整數 |
透過 HTTP 接收更新的連接埠 |
httpsPort |
整數 |
(選擇性)供 HTTPS 伺服器使用的連接埠。 (預設值 443) |
httpsUpdatesPort |
整數 |
(選擇性)透過 HTTPS 接收更新的連接埠。 |
錯誤
範例 |
要求 |
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1 |
回應(API 2) |
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff
{
"manufacturer": "AAA",
"model": "BBB",
"serialNumber": "CCC",
"firmwareVersion": "DDD",
"supportUrl": "EEE",
"endpoints": {
"httpPort": 80,
"httpUpdatesPort": 10080,
...
},
"gps": true,
"gyro": false,
"uptime": 600,
"api": [
"/osc/info",
"/osc/state",
"/osc/checkForUpdates",
"/osc/commands/execute",
"/osc/commands/status"
],
"apiLevel": [1, 2]
} |
回應 (API 1) |
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff
{
"manufacturer": "AAA",
"model": "BBB",
"serialNumber": "CCC",
"firmwareVersion": "DDD",
"supportUrl": "EEE",
"endpoints": {
"httpPort": 80,
"httpUpdatesPort": 10080,
...
},
"gps": true,
"gyro": false,
"uptime": 600,
"api": [
"/osc/info",
"/osc/state",
"/osc/checkForUpdates",
"/osc/commands/execute",
"/osc/commands/status"
]
} |