カメラ内のすべての画像を一覧表示します。このコマンドは API レベル 2 で非推奨になりました。
代わりに camera.listFiles
を使用してください。
リクエストされたパラメータをカメラがサポートしていない場合、カメラは
ハードウェアが持つ能力を最大限に発揮できます。たとえば まれなケースとして
リクエスト: {entryCount: 500, maxSize: 2000}
エラーをスローするのではなく
応答は、カメラがサポートする最大機能に基づいている必要があります。
(例: {entryCount: 100, maxSize: 200}
)。その他すべての場合はエラーをスローしてください。
ケースたとえば、リクエストが {entryCount: 500, maxSize: -500}
の場合、
maxSize
が負の値であるため、エラー invalidParameterValue
がスローされるはずです。
パラメータ
- entryCount: 必要なエントリ数。
- maxSize: サムネイル画像の最大サイズ。max(thumbnail_width, summary_height) です。
includeThumb
が true の場合にのみ必須です(下記を参照)。 - continuationToken: (省略可)前回の
listImages
呼び出しで返された文字列型の不透明な継続トークン。次の画像の取得に使用されます。最初のlistImages
呼び出しでは、このパラメータを省略します。注: トークンを生成するアルゴリズムは、カメラが行います。 - includeThumb: (省略可)デフォルトは
true
です。false
を使用して、結果からサムネイル画像を除外します。
結果
- entries: 画像プロパティのリスト。各エントリには次のフィールドを含める必要があります。
緯度と経度はオプションです。
<ph type="x-smartling-placeholder">
- </ph>
name
: 名前uri
: URIsize
: サイズ(バイト単位)dateTimeZone
: イメージの日付、時刻、タイムゾーン。次の形式になります。YYYY:MM:DD HH:MM:SS+(-)HH:MM
。時刻は 24 時間形式で指定してください。日付 1 つの空白文字で区切られます。 あります。タイムゾーンは UTC 時間からのオフセットです。lat
: (省略可)画像キャプチャ場所の緯度。lng
: (省略可)画像の撮影場所の経度。width
: 画像の幅height
: 画像の高さthumbnail
: サムネイル画像の Base64 エンコード文字列(includeThumb == true
)。
- totalEntries: ストレージ内のエントリの合計数。
- continuationToken: (省略可)結果が不完全な場合にのみ設定します
(「未完了」は、最後の画像が含まれていないリスティングを指します)。残りをフェッチする
クライアントはトークンを使用して
listImages
コマンドを再度呼び出す必要があります。
エラー
- missingParameter: 必須パラメータが指定されていません。
たとえば、
entryCount
は指定されません。 - invalidParameterName: 入力パラメータ名は 認識されません。
- invalidParameterValue: 入力パラメータ名は
認識されていますが、値が無効です。たとえば
continuationToken
は存在しないか、範囲外です。そのデータは データ型が正しくない、includeThumb
のデータ型が正しくない、またはincludeThumb
のとき、maxSize
のデータ型が間違っている あります。
コマンド I/O | |
---|---|
コマンド入力 | { "parameters": { "entryCount": 50, "maxSize": 100, "includeThumb": true } } |
コマンド出力 | { "results": { "entries": [ { "name": "abc", "uri": "image URI", "size": image size in bytes, "dateTimeZone": "2014:12:27 08:00:00+08:00" "lat": 50.5324 "lng": -120.2332 "width": 2000 "height": 1000 "thumbnail": "ENCODEDSTRING" } ... { ... } ], "totalEntries": 250, "continuationToken": "50" } } |
コマンド出力(エラー) | { "error": { "code": "invalidParameterValue", "message": "Parameter continuationToken is out of range." } } |