/osc/commands/status
API は、前の inProgress
コマンドのステータスを返します。 status
API は、以前に発行されたコマンドの進行をポーリングする場合、たとえば、camera.takePicture
が完了したかどうかを判別する場合などに役立ちます。
入力
名前 |
型 |
説明 |
id |
文字列 |
/osc/commands/execute に対する以前の呼び出しによって返されたコマンド ID。 |
出力
出力はコマンド オブジェクトでもあります(/osc/commands/execute
の 出力をご覧ください)。
エラー
エラーコード |
説明 |
missingParameter |
id が指定されていません。 このパラメータには、/osc/commands/execute に対する以前の呼び出しで返されたコマンド ID が必要です。 |
invalidParameterName |
入力パラメータを認識できません。 |
invalidParameterValue |
入力パラメータは認識されましたが、その値が無効です。たとえば、id 値が存在しないか、その型が間違っています。 |
例 |
リクエスト |
POST /osc/commands/status HTTP/1.1
Host: [camera ip address]:[httpPort]
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: {CONTENT_LENGTH}
X-XSRF-Protected: 1
{
"id": "90ABCD"
} |
レスポンス |
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff
{
"name": "camera.takePicture",
"state": "done",
"results": {
"fileUri": "ABC.JPG"
}
} |