camera.listFiles

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Répertorie toutes les images/toutes les vidéos/toutes les images et vidéos de la caméra. Plusieurs requêtes peuvent être nécessaires pour lister tous les fichiers. Cette commande a été ajoutée au niveau d'API 2.

Si une caméra n'est pas compatible avec les paramètres demandés, elle doit renvoyer la capacité maximale disponible pour le matériel. Par exemple, la requête {entryCount: 500, maxSize: 2000} peut être très rare. Au lieu de générer une erreur, la réponse doit être basée sur la capacité maximale acceptée par la caméra, par exemple : {entryCount: 100, maxSize: 200}. Veuillez générer des erreurs pour tous les autres cas. Par exemple, lorsque la requête est {entryCount: 500, maxSize: -500}, elle doit renvoyer l'erreur invalidParameterValue, car la valeur de maxSize est négative.

Paramètres

  • fileType:le type de fichier à répertorier doit correspondre à l'un des trois éléments suivants : "image", "video" ou "all".
  • startPosition (facultatif) : position du premier fichier à afficher dans la liste. En cas d'omission, la position de départ est 0, ce qui correspond au premier fichier. S'il est plus grand que la position du dernier fichier, renvoyez une réponse normale avec des entrées vides dans les résultats au lieu d'une réponse d'erreur.
  • entryCount:le nombre souhaité d'entrées à afficher. S'il est supérieur au nombre de fichiers restants, renvoyez simplement une réponse normale avec les fichiers restants au lieu d'une réponse d'erreur.
  • maxThumbSize : taille maximale des images miniatures ; max(thumbnail_width, miniatures_height). Il est défini sur null lorsque le client souhaite omettre les images de vignettes du résultat.

Résultats

  • entrées:liste des propriétés de l'image. Chaque entrée doit contenir les champs facultatifs, à l'exception de la latitude et de la longitude, qui sont facultatifs :
    • name:nom du fichier.
    • fileUrl : URL absolue du fichier, qui permet d'effectuer un téléchargement directement depuis l'appareil photo.
    • size:taille du fichier en octets.
    • dateTimeZone : date, heure et fuseau horaire du fichier, au format YYYY:MM:DD HH:MM:SS+(-)HH:MM. Indiquez le format 24 heures. La date et l'heure sont séparées par un caractère vide. Le fuseau horaire est décalé par rapport à l'heure UTC. Veuillez noter qu'il s'agit de la fin de la capture de vos vidéos.
    • lat : (facultatif) latitude du lieu au moment de la capture du fichier.
    • lng : (facultatif) longitude du lieu au moment de la capture du fichier.
    • width:largeur de l'image ou de chaque image.
    • height : hauteur de l'image ou de chaque image de vidéo.
    • thumbnail : chaîne encodée en base64 pour la miniature du fichier (lorsque maxThumbSize != null).
    • isProcessed:valeur booléenne indiquant si le fichier est traité (par exemple, assemblé) ou s'il s'agit uniquement d'un aperçu. Cela doit être vrai par défaut, sauf si delayProcessing est défini sur"true". Si une image traitée existe, l'image d'aperçu correspondante ne doit pas être répertoriée même si elle existe. Sinon, répertoriez-la.
    • previewUrl:indiquez une chaîne vide par défaut si delayProcessing n'est pas compatible ou si isProcessed correspond à "false" ou si l'image d'aperçu n'a jamais été générée en tant que résultat intermédiaire. Sinon, il s'agit de l'URL de l'image d'aperçu correspondant à l'image finale. Cela permet de créer la correspondance entre l'image d'aperçu et l'image finale.
  • totalEntries:nombre total d'entrées de fileType dans l'espace de stockage. Par exemple, si fileType est "image", il s'agit du nombre total d'images dans l'espace de stockage.

Erreurs

  • missingParameter:aucun paramètre obligatoire n'est spécifié (par exemple, entryCount n'est pas spécifié).
  • invalidParameterName : le nom du paramètre d'entrée n'est pas reconnu.
  • invalidParameterValue : le nom du paramètre d'entrée est reconnu, mais sa valeur n'est pas valide. Par exemple, la valeur de entryCount est négative ou son type de données est incorrect.

E/S de commande
Saisie de commande 
{
    "parameters": {
        "entryCount": 50,
        "maxThumbSize": 100
    }
}
Résultat de la commande 
{
    "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
    }
}
Résultat de la commande (erreur) 
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter entryCount is negative."
    }
}