/osc/info
API は、カメラに関する基本情報とサポートされる機能を返します。
入力
出力
名前
| 型
| 説明
|
manufacturer |
文字列 |
カメラのメーカー。 |
model |
文字列 |
カメラのモデル。 |
serialNumber |
文字列 |
シリアル番号。 |
firmwareVersion |
文字列 |
現在のファームウェア バージョン。 |
supportUrl |
文字列 |
カメラのサポート ウェブページの URL。 |
gps |
Boolean 型 |
カメラに GPS が備わっている場合は True。 |
gyro |
Boolean 型 |
カメラにジャイロスコープが備わっている場合は 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 |
整数 |
(任意) HTTP サーバー用のポート。 (デフォルトは 443) |
httpsUpdatesPort |
整数 |
(任意) HTTP 経由でアップデートを受け取るポート。 |
エラー
例 |
リクエスト |
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"
]
} |