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, thumb_height)。 只有在 includeThumb 為 true 時才需要 (如下所述)。
  • endinuationToken: (選用) 類型字串的不透明接續權杖,由先前的 listImages 呼叫傳回,用於擷取下一個圖像。請在第一個 listImages 呼叫中省略此參數。注意: 相機會負責產生權杖的演算法。
  • includeThumb: (選用) 預設為 true。使用 false 即可從結果中省略縮圖圖片。

成果

  • 項目:圖片屬性清單。每個項目都應包含下列選填欄位 (經緯度除外),這些欄位為選填:
    • name:名稱
    • uri:URI
    • size:大小 (以位元組為單位)
    • dateTimeZone:圖片的日期、時間和時區,格式為:YYYY:MM:DD HH:MM:SS+(-)HH:MM。時間格式請使用 24 小時制。系統會以一個空白字元分隔日期和時間。時區與世界標準時間不同。
    • lat:(非必要) 圖片拍攝位置的緯度。
    • lng:(選用) 圖片拍攝位置的經度。
    • width:圖片寬度
    • height:圖片高度
    • thumbnail:縮圖的 Base64 編碼字串 (當 includeThumb == true 時)。
  • totalEntries (總計項目):儲存空間中的項目總數。
  • ConinuationToken: (選用) 僅在結果不完整時設定 (「incomplete」是指任何不含上一張圖片的商店資訊)。如要擷取其餘項目,用戶端應使用權杖再次呼叫 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."
    }
}