État

L'API /osc/state renvoie les attributs state de l'appareil photo. La différence entre cette API et l'API info est le fait que l'état state contient des valeurs modifiables représentant le statut de l'appareil photo (batteryLevel, par exemple), tandis que info contient uniquement les attributs fixes de l'appareil photo (par exemple, manufacturer) ou des attributs qui ne changent pas souvent comme firmwareVersion).

Entrée

  • Cette commande ne requiert aucune entrée.

Sortie

Nom Type Description
fingerprint Chaîne Empreinte (identifiant unique) de l'état actuel de l'appareil photo.
state Objet Objet JSON contenant le statut des différents états de l'appareil photo. Voir le tableau ci-dessous.

Objet state

Cet objet JSON fournit le statut des différents états de l'appareil photo. Les fabricants peuvent fournir de nouveaux états personnalisés qui doivent être précédés d'un tiret bas ( _ ) afin d'éviter les conflits d'espace de noms.

Nom Type Description
sessionId Chaîne Identifiant de la session actuelle. Ce champ est devenu obsolète dans l'API niveau 2.
batteryLevel Nombre Exprimé en une valeur de point flottant représentant la batterie restante, ex. : 0,5
storageChanged Valeur booléenne true si un nouveau type de stockage (ex : une carte SD ou une clé USB) est inséré/retiré. Ce champ est devenu obsolète dans l'API niveau 2.
storageUri Chaîne Identifiant unique permettant de différencier différents stockages. Il est utilisé pour indiquer si le stockage a changé ou non. Ce champ a été ajouté dans l'API niveau 2.
_vendorSpecific [type](optional) État supplémentaire spécifique du fournisseur s'appliquant à l'appareil photo. À précéder d'un tiret bas ( _ ) afin d'éviter les conflits d'espace de noms.

Erreur

  • Cette commande ne renvoie aucune erreur.

Exemple

Requête
POST /osc/state HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
Réponse
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
    "fingerprint": "12EGA33",
    "state": {
        "sessionId": "12ABC3",
        "batteryLevel": 0.5,
        "storageChanged": false
    }
}