Schéma du traitement du volume pour la maison connectée

action.devices.traits.Volume : cette caractéristique est disponible sur les appareils qui peuvent modifier le volume (par exemple, régler le volume sur un certain niveau, couper le son ou le réactiver).

ATTRIBUTS de l'appareil

Les appareils disposant de cette caractéristique peuvent signaler les attributs suivants lors de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Traitement des intents.

Attributs	Type	Description
volumeMaxLevel	Entier	Obligatoire. Niveau de volume maximal, en supposant une valeur de référence de 0 (son coupé). L'Assistant ajuste les commandes adverbiales (par exemple, "augmente la puissance du téléviseur").
volumeCanMuteAndUnmute	Booléen	Obligatoire. Indique si l'appareil peut couper le son et le réactiver. Il s 'agit d'une option distincte, car le son est réglé sur 0 tout en se remémorant le volume précédent. L'état du volume est reflété. Si le volume est égal à 5 et que l'utilisateur désactive le son, le volume reste égal à 5 et isMuted est défini sur "true".
volumeDefaultPercentage	Entier	(Par défaut : 40) Volume (en pourcentage) du volume par défaut défini par l'utilisateur ou le fabricant. L'échelle doit être comprise entre 0 et 100.
levelStepSize	Entier	(Par défaut : 1) Taille de pas par défaut pour les requêtes de volume relatives, par exemple "Augmente le volume sur <device_name>".
commandOnlyVolume	Booléen	(Par défaut : false) Indique si l'appareil fonctionne avec une communication unidirectionnelle (true) ou bidirectionnelle (false). Par exemple, si la manette peut confirmer l'état du nouvel appareil après l'envoi de la requête, la valeur du champ est "false". S'il n'est pas possible de confirmer que la requête a bien été exécutée ou d'obtenir l'état de l'appareil (par exemple, s'il s'agit d'une télécommande infrarouge traditionnelle), définissez ce champ sur "true".

Exemples

Haut-parleur pouvant être mis en mode silencieux et signaler l'état actuel

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

Appareil STATES

Les entités dotées de cette caractéristique peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Traitement des intents.

États	Type	Description
currentVolume	Entier	Obligatoire. Pourcentage du volume actuel. Elle doit être comprise entre >0 et volumeMaxLevel.
isMuted	Booléen	Obligatoire si l'attribut volumeCanMuteAndUnmute est défini sur "true". "True" si le son de l'appareil est coupé ; "false" dans le cas contraire. Si isMuted est "true", l'appareil renvoie currentVolume pour le point mémorisé.

Exemples

Haut-parleur pouvant être mis en mode silencieux et signaler l'état actuel

{
  "currentVolume": 5,
  "isMuted": false
}

Appareil COMMANDS

Les appareils disposant de cette caractéristique peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE. Pour en savoir plus sur la gestion des intents EXECUTE, consultez Traitement des intents.

action.devices.commands.mute

Coupe ou désactive le son de l'appareil.

Paramètres

Paramètres	Type	Description
mute	Booléen	Obligatoire. Ce paramètre permet de couper ou réactiver le son d'un appareil.

Exemples

Couper le son du haut-parleur

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

Réglez le volume au niveau demandé, en fonction de volumeMaxLevel.

Paramètres

Paramètres	Type	Description
volumeLevel	Entier	Obligatoire. Nouveau volume, de 0 à volumeMaxLevel.

Exemples

Régler le volume absolu de l'enceinte

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

Définissez un volume à augmenter ou à réduire n pas, en fonction de volumeMaxLevel. Pour les commandes qui utilisent une échelle relative, l'Assistant sélectionne n de manière appropriée pour effectuer le scaling en fonction des étapes disponibles. Par exemple, vous pouvez augmenter le nombre de pas de l'option Augmenter le volume du téléviseur plutôt que Augmenter le volume du téléviseur.

Paramètres

Paramètres	Type	Description
relativeSteps	Entier	Obligatoire. négative pour "diminution".

Exemples

Régler le volume relatif de l'enceinte en mode commande uniquement

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

ERREURS sur l'appareil

Consultez la liste complète des erreurs et exceptions.

• volumeAlreadyMax: l'appareil reçoit la commande VolumeUp lorsqu'elle est déjà au volume le plus élevé.
• volumeAlreadyMin: l'appareil reçoit la commande VolumeDown lorsqu'elle est déjà au volume le plus bas.