/osc/state
API は、カメラの state
属性を返します。 この API と info
API の違いは、state
にはカメラのステータス(batteryLevel
など)を表す可変値が含まれているのに対し、info
にはカメラの静的属性(頻繁には変更されない属性、たとえば manufacturer
や firmwareVersion)
)のみが含まれていることです。
入力
出力
名前
型
説明
fingerprint
文字列
現在のカメラの状態のフィンガープリント(一意の識別子)。
state
オブジェクト
さまざまなカメラの状態のステータスを含む JSON オブジェクト。 次の表をご覧ください。
注: メーカーは、追跡しているカメラの状態が変更されたときにフィンガープリント値を変更する必要がある、フィンガープリンティング アルゴリズムを定義します。 可能な実装は次のとおりです。
現在の状態のハッシュ。
状態が変更されるたびに、単調に増大する数値。
最後の状態変更のタイムスタンプとタイムカウンタ。
state
オブジェクト
この JSON オブジェクトは、さまざまなカメラの状態のステータスを提供します。 メーカーは、新しいカスタム状態を提供できますが、名前空間の競合を防ぐために、アンダースコア(_)を先頭に付ける必要があります。
名前
型
説明
sessionId
文字列
現在のセッションの ID。 このフィールドは、API レベル 2 ではサポートが終了しました。
batteryLevel
数値
バッテリー残量の浮動小数点値(0.5 など)として表されます。
storageChanged
Boolean 型
新しいタイプのストレージ (たとえば、SD カードや USB ドライブ)が挿入されたか、取り外された場合は True。
このフィールドは、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
}
}