kamera.listObrazy

Wyświetla listę wszystkich obrazów w aparacie. To polecenie zostało wycofane w interfejsie API poziomu 2. Zamiast nich używaj elementu camera.listFiles.

Jeśli kamera nie obsługuje żądanych parametrów, musi zwrócić maksymalną wydajność dostępną dla sprzętu. Rzadki przypadek to: {entryCount: 500, maxSize: 2000}. Zamiast zgłaszać błąd, odpowiedź powinna opierać się na maksymalnych możliwościach kamery, np. {entryCount: 100, maxSize: 200}. We wszystkich innych przypadkach zgłaszaj błędy. Jeśli na przykład żądanie ma postać {entryCount: 500, maxSize: -500}, powinno zwrócić błąd invalidParameterValue, ponieważ maxSize ma wartość ujemną.

Parametry

  • entryCount:żądana liczba pozycji do zwrócenia;
  • maxSize: maksymalny rozmiar obrazów miniatur; max(Miniatura_szerokość, wysokość_miniatury). Wymagane tylko wtedy, gdy zasada includeThumb ma wartość prawda (poniżej).
  • continuationToken: (opcjonalny) nieprzejrzysty token kontynuacji ciągu znaków, zwracany przez poprzednie wywołanie metody listImages, używany do pobierania następnych obrazów. Pomiń ten parametr przy pierwszym wywołaniu funkcji listImages. Uwaga: aparat odpowiada za algorytm, który generuje token.
  • includeThumb: (opcjonalnie) wartość domyślna: true. Użyj false, aby pominąć miniatury w wynikach.

Wyniki

  • entries: lista właściwości obrazu. Każda pozycja powinna zawierać następujące pola z wyjątkiem szerokości i długości geograficznej, które są opcjonalne:
    • name: nazwa
    • uri: identyfikator URI
    • size: rozmiar w bajtach
    • dateTimeZone: data, godzina i strefa czasowa zdjęcia w formacie: YYYY:MM:DD HH:MM:SS+(-)HH:MM. Użyj formatu 24-godzinnego. Data i godzina są oddzielone jednym pustym znakiem. Strefa czasowa jest przesunięta w stosunku do czasu UTC.
    • lat: (opcjonalnie) szerokość geograficzna lokalizacji zrobienia zdjęcia.
    • lng: (opcjonalnie) długość geograficzna miejsca zrobienia zdjęcia.
    • width: szerokość obrazu
    • height: wysokość obrazu
    • thumbnail: ciąg zakodowany w standardzie Base64 obrazu miniatury (gdy includeThumb == true).
  • totalEntries: łączna liczba wpisów w pamięci.
  • continuationToken: (opcjonalnie) ustaw tylko wtedy, gdy wynik jest niekompletny (niekompletny oznacza wszystkie informacje, które nie zawierają ostatniego obrazu). Aby pobrać pozostałe wpisy, klient powinien ponownie wywołać polecenie listImages z tokenem.

Błędy

  • missingParameter:nie określono żadnego wymaganego parametru, np. entryCount.
  • ErrorParameterName: nie udało się rozpoznać nazwy parametru wejściowego.
  • Nieprawidłowy parametr: rozpoznano nazwę parametru wejściowego, ale jego wartość jest nieprawidłowa, np. continuationToken nie istnieje, jest poza zakresem, ma nieprawidłowy typ danych, typ danych includeThumb jest nieprawidłowy lub maxSize ma nieprawidłowy typ danych, gdy parametr includeThumb ma wartość prawda.

Command I/O
Polecenie 
{
    "parameters": {
        "entryCount": 50,
        "maxSize": 100,
        "includeThumb": true
    }
}
Dane wyjściowe polecenia 
{
    "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"
    }
}
Dane wyjściowe polecenia (błąd) 
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter continuationToken is out of range."
    }
}