camera.listImages

カメラ内のすべての画像を一覧表示します。このコマンドは API レベル 2 で非推奨になりました。代わりに camera.listFiles を使用してください。

リクエストされたパラメータをカメラがサポートしていない場合、カメラはハードウェアで利用可能な最大機能を返す必要があります。たとえば、まれなケースとしては {entryCount: 500, maxSize: 2000} というリクエストが考えられます。レスポンスは、エラーをスローする代わりに、カメラがサポートする最大機能({entryCount: 100, maxSize: 200} など)に基づく必要があります。それ以外の場合はすべてエラーをスローしてください。たとえば、リクエストが {entryCount: 500, maxSize: -500} の場合、maxSize が負の値であるため、エラー invalidParameterValue をスローします。

パラメータ

  • entryCount: 返されるエントリの数。
  • maxSize: サムネイル画像の最大サイズ。max(thumbnail_width,thumbnail_width,thumbnail_height)。includeThumb が true(下記)の場合にのみ必要です。
  • continuationToken:(省略可)前の listImages 呼び出しで返された、文字列型の不透明な継続トークン。次の画像の取得に使用されます。最初の listImages 呼び出しでは、このパラメータを省略します。注: カメラは、トークンを生成するアルゴリズムを担います。
  • includeThumb: (省略可)デフォルトは true です。false を使用すると、結果からサムネイル画像を省略できます。

結果

  • entries: 画像プロパティのリスト。各エントリには、省略可能な緯度と経度を除いて、次のフィールドを含める必要があります。
    • name: 名前
    • uri: URI
    • size: サイズ(バイト単位)
    • dateTimeZone: イメージの日付、時刻、タイムゾーン(YYYY:MM:DD HH:MM:SS+(-)HH:MM 形式)。時刻には 24 時間形式を使用します。日付と時刻は空白文字で区切られます。タイムゾーンは UTC 時間からのオフセットです。
    • lat: (省略可)画像キャプチャの場所の緯度。
    • lng: (省略可)画像キャプチャの場所の経度。
    • width: 画像の幅
    • height: 画像の高さ
    • thumbnail: サムネイル画像の Base64 でエンコードされた文字列(includeThumb == true の場合)。
  • totalEntries: ストレージ内のエントリの合計数。
  • continuationToken: (省略可)結果が不完全な場合にのみ設定します(「不完全な」とは、最後の画像が含まれていないリスティングを意味します)。残りのエントリをフェッチするには、クライアントはトークンを使用して listImages コマンドを再度呼び出す必要があります。

エラー

  • missingParameter: 必須パラメータが指定されていません。たとえば、entryCount が指定されていません。
  • invalidParameterName: 入力パラメータ名を認識できません。
  • invalidParameterValue: 入力パラメータ名を認識しましたが、その値が無効です。たとえば、continuationToken が存在しない、範囲外である、データ型が正しくない、includeThumb のデータ型が正しくない、includeThumb が true のときに 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."
    }
}