リクエストされたプロパティの現在の設定を返します。このコマンドは API レベル 2 で変更されました。
パラメータ
- sessionId: 取得した文字列型の一意のセッション ID
camera.startSession
コマンドを使用します このフィールドは API レベル 2 で非推奨になりました。 - optionNames: 返されるプロパティ名の文字列配列。
結果
- options: リクエストされたプロパティの JSON
<key, value>
ペア。 値は、String
、String Array
、Number
のいずれかの型になります。Number Array
、Boolean
、Object
、Object Array
。詳しくは、 オプション。
エラー
- missingParameter: 1 つ以上の必須パラメータが指定されていません。
たとえば、
optionNames
は指定されません。 - invalidParameterName: 1 つ以上の入力パラメータ名またはオプション
名前が認識されないかサポートされていません。例:エラーがある場合は、このコードが返されます。
API レベル 2 のオプション(
captureInterval
など)は、clientVersion
のときに使用されます。 (Options
の)は 1 です。 - invalidParameterValue: 入力パラメータ名は認識されますが、
1 つ以上の値が無効です。たとえば、
sessionId
が存在しない場合、 無効であるか、データ型が正しくありません。このエラーコードは API レベル 2 になります。これは、いずれかのオプション名が無効な場合、invalidParameterName
返されます。
コマンド I/O | |
---|---|
コマンド入力(API レベル 1) | { "parameters": { "sessionId": "12ABC3", "optionNames": [ "iso", "isoSupport" ] } } |
コマンド出力(API レベル 1) | { "results": { "options": { "iso": 200, "isoSupport": [100, 200, 400, 800, 1600] } } } |
コマンド出力(エラー)(API レベル 1) | { "error": { "code": "invalidParameterName", "message": "Parameter optionNames contains unrecognized option XYZ." } } |
コマンド入力(API レベル 2) | { "parameters": { "optionNames": [ "iso", "isoSupport" ] } } |
コマンド出力(API レベル 2) | { "results": { "options": { "iso": 200, "isoSupport": [100, 200, 400, 800, 1600] } } } |
コマンド出力(エラー)(API レベル 2) | { "error": { "code": "invalidParameterName", "message": "Parameter optionNames contains unrecognized option XYZ." } } |