camera.listImages

列出相機中的所有圖片。這個指令已在 API 級別 2 中淘汰, 請改用 camera.listFiles

如果相機不支援所要求的參數,相機必須傳回 可用的最高功能舉例來說 要求:{entryCount: 500, maxSize: 2000}。系統不會擲回錯誤 回應應以相機支援的最大功能為依據 例如:{entryCount: 100, maxSize: 200}。請擲回其他錯誤 案件;例如,如果要求是 {entryCount: 500, maxSize: -500} 應擲回錯誤 invalidParameterValue,因為 maxSize 為負數。

參數

  • entryCount:要傳回的項目數量。
  • maxSize:縮圖圖片大小的大小上限;max(thumbnail_width, 縮圖_height))。 只有在 includeThumb 為 true (如下圖所示) 時才需要。
  • continuationToken: (選用) 類型字串的不透明連續權杖,由先前的 listImages 呼叫傳回,用來擷取下一張圖片。第一次 listImages 呼叫時,請省略此參數。注意: 相機負責產生權杖的演算法。
  • includeThumb: (選用) 預設為 true。使用 false 即可從結果中省略縮圖。

結果

  • entries:圖片屬性清單。每個項目應包含下列欄位 經緯度,兩者皆可選用:
    • name:名稱
    • uri:URI
    • size:大小 (以位元組為單位)
    • dateTimeZone:圖片的日期、時間和時區,格式為: YYYY:MM:DD HH:MM:SS+(-)HH:MM。請以 24 小時製表示時間。日期 而時間則會留空 字元。時區與世界標準時間的差距。
    • lat:(選用) 圖片拍攝位置的緯度。
    • lng:(選填) 圖片拍攝位置的經度。
    • width:圖片寬度
    • height:圖片高度
    • thumbnail:縮圖圖片的 Base64 編碼字串 (當 includeThumb == true)。
  • totalEntries (總項目):儲存空間中的項目總數。
  • continuationToken: (選用) 僅在結果不完整時設定 (「未完成」表示產品資訊中未包含最後一張圖片)。擷取剩餘 項目,用戶端應使用權杖再次呼叫 listImages 指令。

錯誤

  • missingParameter:未指定任何必要參數; 例如未指定 entryCount
  • INVALIDParameterName:輸入參數名稱是 則無法辨識。
  • invalidParameterValue::輸入參數名稱是 ,但其值無效;例如 continuationToken不存在、超出範圍,其資料 類型不正確、includeThumb 的資料類型不正確,或 includeThumb 是:maxSize 的資料類型有誤 true。

指令 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."
    }
}