aparat.listPliki

Wyświetla wszystkie obrazy/wszystkie filmy/wszystkie obrazy i filmy w aparacie. Może to zająć kilku żądań wyświetlenia wszystkich plików. To polecenie zostało dodane na poziomie interfejsu API 2.

Jeśli kamera nie obsługuje żądanych parametrów, musi zwracać błąd z maksymalnymi możliwościami sprzętowymi. Rzadkim przypadkiem może być np. żądanie: {entryCount: 500, maxSize: 2000}. Zamiast zgłaszać błąd, odpowiedź powinna opierać się na maksymalnych możliwościach kamery, na przykład: {entryCount: 100, maxSize: 200}. Błędy w pozostałych przypadkach przypadki; na przykład jeśli żądanie to {entryCount: 500, maxSize: -500}, powinien zgłosić błąd invalidParameterValue, ponieważ maxSize ma wartość ujemną.

Parametry

  • fileType:typ plików do wyświetlenia – powinien to być dowolny z tych trzy: „obraz”, „wideo” i „wszystkie”.
  • startPosition: (opcjonalnie) pozycja pierwszego pliku na liście. Jeśli zostanie pominięta, pozycja początkowa ma wartość 0, co odpowiada pierwszy plik. Jeśli jest większa niż pozycja ostatniego pliku, zwróć zwykła odpowiedź z pustymi wpisami w wynikach zamiast odpowiedzi o błędzie.
  • entryCount: wymagana liczba wpisów do zwrócenia. Jeśli tak więcej niż liczba pozostałych plików, zwróć zwykłą odpowiedź z żądaniem informacje o pozostałych plikach, a nie w odpowiedzi na błąd.
  • maxThumbSize: maksymalny rozmiar miniatur miniatur. max(Miniatura_szerokość, wysokość_miniatury). Ma ona wartość null, gdy klient chce pominąć miniatury w wynikach.

Wyniki

  • entries: lista właściwości obrazu. Każdy wpis powinien zawierać następujące pola oprócz szerokości i długości geograficznej, które są opcjonalne:
    • name: nazwa pliku.
    • fileUrl: bezwzględny adres URL pliku, którego można użyć do pobrania bezpośrednio z kamery.
    • size: rozmiar pliku w bajtach.
    • dateTimeZone: data, godzina i strefa czasowa pliku w formacie: YYYY:MM:DD HH:MM:SS+(-)HH:MM Podaj godzinę w formacie 24-godzinnym. Data i są rozdzielone jednym pustym znakiem. Strefa czasowa jest odsunięta od czasu UTC. Pamiętaj o tym oznacza zakończenie nagrywania.
    • lat: (opcjonalnie) szerokość geograficzna lokalizacji w momencie przechwycenia pliku.
    • dł.: (opcjonalnie) długość lokalizacji w momencie przechwycenia pliku.
    • width: szerokość obrazu lub każdej klatki wideo.
    • height: wysokość obrazu lub każdej klatki wideo.
    • thumbnail (miniatura): ciąg zakodowany w standardzie Base64 dla obrazu miniatury pliku (gdy maxThumbSize != null).
    • isProcessed: wartość logiczna wskazująca, czy plik (np. zszytych) lub to tylko podgląd. Powinno to nastąpić do domyślnie, chyba że zasada delayProcessing ma wartość Prawda. Jeśli istnieje przetworzone zdjęcie, obraz podglądu nie powinien być wymieniony, nawet jeśli istnieje; w przeciwnym razie wymień obraz podglądu.
    • previewUrl: domyślnie pusty ciąg znaków, jeśli delayProcessing nie jest obsługiwana lub gdy isProcessed ma wartość Fałsz lub gdy obraz podglądu nie został wygenerowany jako wynik pośredni, w przeciwnym razie jest to adres URL który odpowiada ostatecznemu obrazowi. Jest ona wykorzystywana do tworzenia między podglądem a ostateczną wersją obrazu.
  • totalEntries: łączna liczba wpisów z fileType w pamięci masowej, np. jeśli atrybut fileType ma wartość „image”, jest to łączna liczba obrazów w pamięci masowej.

Błędy

  • missingParameter:nie określono żadnego wymaganego parametru; na przykład entryCount nie został określony.
  • invalidParametrName:nazwa parametru wejściowego to Nie rozpoznano.
  • invalidParameterValue::nazwa parametru wejściowego została rozpoznana, , ale jego wartość jest nieprawidłowa; na przykład entryCount jest ujemny lub typ danych jest nieprawidłowy.

Polecenie I/O
Dane wejściowe polecenia 
{
    "parameters": {
        "entryCount": 50,
        "maxThumbSize": 100
    }
}
Dane wyjściowe polecenia 
{
    "results": {
        "entries": [
            {
                "name": "abc",
                "fileUrl": "file URL",
                "size":  file size, # of bytes,
                "dateTimeZone": "2014:12:27 08:00:00+08:00",
                "lat": 50.5324,
                "lng": -120.2332,
                "width": 2000,
                "height": 1000,
                "thumbnail": "ENCODEDSTRING",
                "isProcessed": true,
                "previewUrl": ""
            }
            ...
            {
                ...
            }
        ],
        "totalEntries": 250
    }
}
Dane wyjściowe polecenia (błąd) 
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter entryCount is negative."
    }
}