Options

Le tableau suivant présente toutes les options disponibles pour définir et obtenir par camera.setOptions et camera.getOptions. Impossible de modifier une option lorsque la compatibilité correspondante est vide ou qu'elle ne contient qu'une seule option.

Nom Type Description Lecture/Écriture
captureMode String Mode de capture actuel. Valeur par défaut : image. rw
captureModeSupport Tableau de chaînes Liste des modes de capture actuellement disponibles. L'exigence minimale pour l'API de niveau 1 est ["image"], et l'exigence minimale pour l'API de niveau 2 est ["image", "interval"], où "interval" représente le mode de capture d'une série d'images espacées à un certain intervalle. Consultez également captureInterval et captureIntervalSupport. Deux modes supplémentaires sont ("video" and "walkaround")compatibles avec le niveau d'API 2. Ainsi, le niveau d'API 2 est ["image", "interval", "video", "walkaround"], où "video" représente le mode de capture vidéo et "walkaround" représente le mode de capture de deux images dans l'ordre, le premier avec les utilisateurs debout par rapport à l'appareil photo et le second avec les utilisateurs debout du côté opposé (par rapport au premier point de l'appareil photo). L'appareil photo peut ainsi supprimer les utilisateurs de l'image finale en combinant les deux images. Lorsque "walkaround" est compatible avec l'appareil photo et défini comme mode de capture actuel, le client doit s'attendre à envoyer deux commandes "TakePicture" à l'appareil photo. La réponse à la première commande (une fois la commande terminée) indique que l'appareil photo est prêt à prendre la deuxième image, tandis que la deuxième commande renvoie l'image finale lorsqu'elle est terminée.

Pour ajouter d'autres modes de capture qui ne sont pas encore acceptés, veuillez ajouter un trait de soulignement ( _) devant les modes spécifiques au fournisseur.

Cette option a été modifiée au niveau de l'API 2.

r
captureStatus String État de la capture actuelle. Valeur par défaut : "idle" Cette valeur est utile pour déterminer l'état de la caméra lorsqu'elle est connectée pour la première fois à une application. Si elle est en train de filmer une vidéo, vous devrez peut-être l'arrêter avant d'effectuer d'autres tâches, par exemple une autre séance photo.

Cette option a été ajoutée au niveau d'API 2.1.

rw
captureStatusSupport Tableau de chaînes Liste des états de capture actuellement disponibles. La valeur par défaut doit être ["idle", "shooting"] si la prise de vue vidéo est possible. D'autres statues peuvent être fournies, par exemple "downloading".

Cette option a été ajoutée au niveau d'API 2.1.

r
exposureProgram Number Programme d'exposition actuel. rw
exposureProgramSupport Tableau de nombres Liste des programmes d'exposition actuellement disponibles (par exemple, [0, 1, 2, 3, 4]) Chaque entier représente un programme d'exposition différent :
  • 0 = Non défini
  • 1 = Manuel
  • 2 = Programme normal
  • 3 = Ouverture de l'ouverture
  • 4 = Priorité de l'obturateur
Cliquez sur le lien suivant pour télécharger plus d'informations sur ExposureProgram.
r
iso Number Paramètre actuel de la vitesse ISO. rw
isoSupport Tableau de nombres

Niveau d'API 1 : liste des paramètres ISO actuellement disponibles (par exemple, [100, 200, 400, 800,1600] ou [] lorsqu'il est en mode auto).

Niveau d'API 2:liste des paramètres ISO actuellement disponibles (par exemple, [0, 100, 200, 400, 800, 1600], où 0 représente le mode auto).

Cette option a été modifiée au niveau de l'API 2.

r
shutterSpeed Number Paramètre actuel de la vitesse d'obturation. rw
shutterSpeedSupport Tableau de nombres

Niveau d'API 1 : liste des vitesses d'obturation disponibles actuellement (par exemple, [0.067, 0.033, 0.017,0.008] ou [] lorsqu'il est en mode auto).

Niveau d'API 2:liste des vitesses d'obturation actuellement disponibles, par exemple [0, 0.067, 0.033, 0.017, 0.008], où 0 représente le mode auto.

Cette option a été modifiée au niveau de l'API 2.

r
aperture Number Ouverture de l'ouverture actuelle en f-stops. rw
apertureSupport Tableau de nombres

Niveau d'API 1 : liste des paramètres d'ouverture actuellement disponibles, exprimée en f/number (par exemple, [1.4, 2, 2.8, 4, 5.6, 8, 11] ou [] lorsqu'elle est en mode auto)

Niveau d'API 2 : liste des paramètres d'ouverture actuellement disponibles, exprimée en f/number (par exemple, [0, 1.4, 2, 2.8, 4, 5.6, 8, 11], où 0 représente le mode auto)

r
whiteBalance String Paramètre de la balance des blancs actuelle, par exemple daylight. La valeur par défaut est auto. rw
whiteBalanceSupport Tableau de chaînes Liste des paramètres de la balance des blancs actuellement disponibles. Elle peut être un sous-ensemble de la liste prédéfinie:[ "auto", "incandescent", "fluorescent", "daylight", "cloudy-daylight", "shade", "twilight"]. Valeurs pour chaque type de conversion :
  • incandescent, environ 3 200 000
  • fluorescent, environ 4 000 K
  • datalight, environ 5 200 000
  • cloudy-daylight, environ 6 000 K
  • shade, environ 7 000 K
  • twilight, environ 12 000 k
Ajoutez un trait de soulignement au début des noms de paramètres propres aux fournisseurs. Par exemple: _vendor-setting
r
exposureCompensation Number Compensation d'exposition actuelle. rw
exposureCompensationSupport Tableau de nombres Liste des compensations d'exposition actuellement disponibles, généralement à l'étape 0,33 ou 0,5. Exemple : [-1, -0.67, -0.33, 0, 0.33, 0.67, 1] r
fileFormat Objet

Type de fichier actuel et résolution Le format doit correspondre à la valeur actuelle de captureMode. Par exemple, si captureMode est image, une réponse appropriée peut être:

{
    "type": "jpeg",
    "width": 2000,
    "height": 1000
}
Si captureMode est video, la réponse appropriée peut être :
{
    "type": "mp4",
    "width": 1920,
    "height": 1080,
    "framerate": 30
}

Cette option a été modifiée au niveau de l'API 2.

rw
fileFormatSupport Tableau d'objets

Liste des formats de fichiers actuellement disponibles, par exemple:

[
    {
    "type": "jpeg",
    "width": 2000,
    "height": 1000
    },
    {
    "type": "jpeg",
    "width": 200,
    "height": 100
    },
    {
    "type": "mp4",
    "width": 1920,
    "height": 1080,
    "framerate": 24
    },
    {
    "type": "mp4",
    "width": 1280,
    "height": 720,
    "framerate": 30
    },
    ...
]
Cliquez sur le lien suivant pour en savoir plus sur tous les types.

Cette option a été modifiée au niveau de l'API 2.

r
exposureDelay Number Délai actuel, en secondes, entre la commande takePicture et le début de l'exposition. rw
exposureDelaySupport Tableau de nombres Liste des retards d'exposition actuellement disponibles, en secondes. Exemple : [0, 1, 2, 5, 10, 30, 60]. r
sleepDelay Number Délai actuel avant l'arrêt de la caméra, en secondes. rw
sleepDelaySupport Tableau de nombres Liste des retards de sommeil actuellement disponibles, en secondes. Exemple : [30, 60, 120, 300, 600, 1800, 65535], où 65535 désactive le mode Sommeil (la caméra ne reste pas en veille tant qu'elle n'est pas éteinte) et doit être compatible. r
offDelay Number Délai actuel, en secondes, avant l'arrêt de la caméra. rw
offDelaySupport Tableau de nombres Liste des retards d'extinction actuellement disponibles, en secondes. Exemple : [1800, 3600, 7200, 65535], où 65535 désactive le mode Éteindre (la caméra ne s'éteint que lorsque la batterie est déchargée ou éteinte manuellement) et doit être compatible. r
totalSpace Number Lecture seule: nombre d'octets de l'espace de stockage total. r
remainingSpace Number Lecture seule: nombre d'octets d'espace de stockage offert. r
remainingPictures Number Lecture seule: estimation du nombre de photos restantes en fonction du paramètre de capture actuel. r
gpsInfo Objet

Informations GPS actuelles. Défini à l'aide de setOptions via le GPS du téléphone:

{
    "lat": 23.532,
    "lng": -132.35
}
Les propriétés lat et lng sont des degrés décimaux, avec lat dans la plage, [-90, 90], et lng dans la plage, [-180, 180]. Lorsqu'elle est fournie par un téléphone, veuillez noter que chaque position GPS n'est valide que jusqu'à la prochaine mise à jour du téléphone. Le téléphone doit déterminer quand la position GPS doit être mise à jour (par exemple, juste avant chaque commande takePicture). 65535 indique à la caméra que la position GPS actuelle n'est pas valide. La caméra doit l'ignorer et utiliser son propre GPS, le cas échéant. Par exemple, setOptions({"gpsInfo": {"lat": 65535, "lng": 65535}}) signifie que la position GPS n'est pas valide.
rw
dateTimeZone String Informations sur la date et l'heure actuelles. Défini par setOptions en fonction de la date, de l'heure et du fuseau horaire du téléphone. Le format est le suivant : YYYY:MM:DD HH:MM:SS+(-)HH:MM. L'heure est au format 24 heures, la date et l'heure sont séparées par un espace, et le fuseau horaire est un décalage par rapport à l'heure UTC. Par exemple, 2014:05:18 01:04:29+8:00 est le fuseau horaire de la Chine (UTC+8:00). rw
hdr

API level 1:booléen

API level 2:chaîne

Niveau d'API 1 : activez ou désactivez le mode de capture HDR. La valeur est true pour activer le HDR ou false pour le désactiver. La valeur par défaut est false. Le paramètre ne peut être true que lorsque hdrSupport est aussi true.

Niveau d'API 2:mode HDR actuel du type "Chaîne".

Cette option a été modifiée au niveau de l'API 2.

rw
hdrSupport

API level 1 : booléen

Niveau d'API 2:tableau de chaînes

Niveau d'API 1 : la valeur true signifie que la caméra est compatible avec la technologie HDR. Le paramètre false permet d'identifier une caméra sans HDR.

Niveau d'API 2 : si vous n'êtes pas compatible avec le mode HDR, il s'agit de [“off”]. Si vous n'acceptez qu'un mode HDR, il est [“off”, “hdr”]. Si plusieurs modes HDR (différents algorithmes) sont compatibles, la valeur est [“off”, “hdr”, “hdr1”, “hdr2”, ...].

Cette option a été modifiée au niveau de l'API 2.

r
exposureBracket Objet Parenthèse exposition actuelle. Disponible uniquement lorsque hdrSupport == true (niveau d'API 1) ou hdrSupport contient au moins un mode HDR (niveau d'API 2). Si l'appareil photo utilise le bracketing d'exposition manuel, l'objet contient deux entrées :
  1. shots, un entier contenant le nombre de plans à prendre.
  2. increment, un nombre contenant un incrément de VE entre les plans.
Par exemple :
{
    "shots": 3,
    "increment": 1.33
}
Si l'appareil photo utilise le bracketing d'exposition automatique, l'objet contient :
{
    "autoMode": true
}

Niveau d'API 1 : le champ {} est vide par défaut lorsque le paramètre hdrSupport == false est défini. Les fabricants choisissent des valeurs par défaut (par exemple, le bracketing d'exposition automatique) lorsque la valeur de hdr est true.

Niveau d'API 2 : la valeur par défaut {} est vide lorsque hdrSupport ne contient que "off". Sinon, les fabricants décident des valeurs par défaut (par exemple, le bracketing d'exposition automatique).

Cette option a été modifiée au niveau de l'API 2.

rw
exposureBracketSupport Objet

Paramètres de crochet d'exposition actuellement disponibles. Exemples:

{
    "autoMode": true,
    "shotsSupport": [1, 3, 5, 7],
    "incrementSupport": [0.33, 0.67, 1, 1.33, 1.67, 2]
}

Niveau d'API 1 : la valeur par défaut est {} si hdrSupport == false. Lorsque hdrSupport == true est défini, mais que le bracketing d'exposition automatique n'est pas accepté, la valeur de autoMode est false.

Niveau d'API 2:la valeur par défaut est {} si hdrSupport ne contient que "off". Lorsque hdrSupport contient un mode HDR, mais que le bracketing d'exposition automatique n'est pas accepté, alors autoMode est false.

Cette option a été modifiée au niveau de l'API 2.

r
gyro Booléen Définissez la valeur sur true pour activer le module du gyroscope de la caméra ou sur false pour la désactiver. Définissez la valeur par défaut sur true si la caméra est compatible. Sinon, définissez-la sur false. Ce paramètre ne peut être true que si gyroSupport == true. rw
gyroSupport Booléen Si la caméra est équipée d'un gyroscope, cette valeur doit être true. Sinon, false. r
gps Booléen Active/désactive le module GPS de la caméra. La valeur doit être true pour l'activer ou false pour la désactiver. La valeur par défaut est true si la caméra le permet, sinon false. Le paramètre est défini sur true uniquement lorsque gpsSupport == true. rw
gpsSupport Booléen Cette valeur doit être true si la caméra possède son propre module GPS, sinon false. r
imageStabilization String Stabilisation de l'image actuelle, par exemple off rw
imageStabilizationSupport Tableau de chaînes Options de stabilisation d'image actuellement disponibles. La liste prédéfinie est ["off", "on"]. Si la caméra n'est pas compatible avec la stabilisation de l'image, renvoyez ["off"]. Sinon, renvoyez ["off", "on"]. et doit être précédé d'un trait de soulignement ( _). Par exemple : [ "off", "_horizontal_stabilization", "_vibration_correction" ]. r
wifiPassword String
Au moins huit caractères, avec des lettres, des chiffres et des symboles, mais pas d'espaces. Elle ne peut être modifiée que lorsque la caméra est connectée à un appareil client. Une fois la modification effectuée, la caméra doit se déconnecter pour que l'utilisateur se reconnecte à l'aide de la nouvelle wifiPassword.
La caméra doit fournir un mécanisme de réinitialisation en cas d'oubli du mot de passe (par exemple, un bouton permettant de rétablir le mot de passe par défaut).
w
previewFormat Objet

Résolution de l'aperçu en direct actuelle:

{
    "width": 640,
    "height": 320,
    "framerate": 24
}

Cette option a été ajoutée au niveau d'API 2.

rw
previewFormatSupport Tableau d'objets

Formats d'aperçu en direct actuellement compatibles:

[
    {
    "width": 640,
    "height": 320,
    "framerate": 24
    },
    ...
    {
    "width": 1280,
    "height": 720,
    "framerate": 24
    }
]

Cette option a été ajoutée au niveau d'API 2.

r
captureInterval Number Intervalle actuel entre la capture de deux images consécutives, dans seconds.

Cette option a été ajoutée au niveau d'API 2.

rw
captureIntervalSupport Objet

Intervalles minimal et maximal autorisés entre deux images consécutives, en secondes. Exemple:

{
    "minInterval": 10,
    "maxInterval": 60
}
Cette valeur peut varier en fonction de fileFormat.

Cette option a été ajoutée au niveau d'API 2.

r
captureNumber Number Nombre d'images à capturer pour une session de capture par intervalles. La valeur par défaut est 0. Cela signifie que la capture doit être arrêtée explicitement par la commande stopCapture. Sinon, la capture s'arrête automatiquement lorsqu'elle capture les images du nombre spécifié. La capture peut également être interrompue lorsque la caméra est déchargée ou qu'elle est éteinte intentionnellement.

Cette option a été ajoutée au niveau d'API 2.

rw
captureNumberSupport Objet

Nombre minimal et maximal d'images pouvant être capturées lors d'une capture par intervalles. Exemple:

{
    "minNumber": 2,
    "maxNumber": 50
}
Elle peut varier en fonction de l'espace de stockage restant.

Cette option a été ajoutée au niveau d'API 2.

r
remainingVideoSeconds Number Estimation du nombre de seconds pour la vidéo restante en fonction du paramètre de capture actuel.

Cette option a été ajoutée au niveau d'API 2.

r
pollingDelay Number Intervalle minimal, en secondes, entre deux requêtes d'interrogation consécutives. Les clients doivent utiliser ce champ pour guider leur comportement d'interrogation d'état. Par exemple, lorsqu'ils assemblent une image, ils peuvent avoir besoin d'interroger régulièrement la caméra pour vérifier si l'assemblage est terminé. La prise en charge varie selon les caméras. Par exemple, certaines caméras peuvent gérer l'interrogation de l'état toutes les secondes et d'autres avec un intervalle plus long.

Cette option a été ajoutée au niveau d'API 2.

r
delayProcessing Booléen True lorsque le traitement (par exemple, l'assemblage) a une priorité inférieure à la capture. En d'autres termes, une autre capture est autorisée avant la fin du traitement de l'image capturée précédemment. Cette méthode est vivement recommandée, en particulier pour les caméras qui nécessitent un temps de traitement long.

Cette option a été ajoutée au niveau d'API 2.

rw
delayProcessingSupport Tableau booléen

[true] signifie que le traitement (l'assemblage, par exemple) a une priorité inférieure à la capture et qu'il est toujours retardé par défaut.

[false] signifie que le traitement est effectué immédiatement après la capture.

[true, false] signifie que vous pouvez choisir entre ces deux modes.

Cette option a été ajoutée au niveau d'API 2.

r
clientVersion Number

Niveau d'API que le client décide d'utiliser. La valeur par défaut est 1 si la caméra est compatible avec les API de niveau 1 et 2. Les clients écrits pour le niveau d'API 1 continuent donc de fonctionner avec la caméra sans aucune modification. La valeur par défaut est 2 si la caméra n'accepte que le niveau d'API 2, qui n'est pas recommandé avant la migration des clients vers l'API. Si la caméra n'accepte que le niveau d'API 2, la requête visant à la définir sur 1 doit échouer. Si clientVersion est défini sur 2 et qu'une commande obsolète du niveau d'API 1 est demandée, la requête doit échouer avec le code d'erreur unknownCommand.

Cette option a été ajoutée au niveau d'API 2.

rw
photoStitchingSupport Tableau de chaînes

Liste des options d'assemblage des photos. Renvoyez [ondevice] si les photos sont assemblées sur l'appareil photo, [none] si l'appareil photo ne peut pas les assembler et [none,ondevice] si l'assemblage est configurable par l'utilisateur. Ajoutez le trait de soulignement aux noms de paramètres propres aux fournisseurs. Par exemple : _vendor-setting.

Cette option a été ajoutée au niveau d'API 2.1.

r
photoStitching String

Option d'assemblage actuel des photos, par exemple ondevice. S'il est compatible, la valeur par défaut est ondevice.

Cette option a été ajoutée au niveau d'API 2.1.

rw
videoStitchingSupport Tableau de chaînes

Liste des options d'assemblage des vidéos. Renvoyez [ondevice] si les vidéos sont toujours assemblées sur la caméra, [none] si la caméra ne peut pas effectuer les assemblages et [none,ondevice] si l'assemblage est configurable par l'utilisateur. Ajoutez le trait de soulignement aux noms de paramètres propres aux fournisseurs. Par exemple : _vendor-setting.

Cette option a été ajoutée au niveau d'API 2.1.

r
videoStitching String

Option d'assemblage actuel des vidéos, par exemple ondevice. S'il est compatible, la valeur par défaut est ondevice.

Cette option a été ajoutée au niveau d'API 2.1.

rw
videoGPSSupport Tableau de chaînes

Liste des options GPS lors de la capture vidéo. Renvoyez [continuous] si la caméra peut enregistrer en continu le GPS pendant la capture vidéo et intégrer les lieux dans la vidéo. Renvoyez [none] si ce n'est pas possible, puis [none,continuous] si la compatibilité GPS de la vidéo est configurable par l'utilisateur. Ajoutez le trait de soulignement aux noms de paramètres propres au fournisseur, par exemple _vendor-setting.

Cette option a été ajoutée au niveau d'API 2.1.

r
videoGPS String

Option actuelle de prise en charge du GPS lors de la capture vidéo, par exemple continuous. S'il est compatible, la valeur par défaut est continuous.

Cette option a été ajoutée au niveau d'API 2.1.

rw
_vendorSpecific [type] (facultatif) Options supplémentaires de l'appareil photo du fournisseur. Ajoutez un trait de soulignement ( _) avant les chaînes spécifiques aux fournisseurs.