Schéma du trait de canal pour la maison connectée

action.devices.traits.Channel : ce trait appartient aux appareils qui prennent en charge les chaînes TV sur un appareil multimédia.

Les chaînes disponibles doivent être partagées sous forme de liste, par utilisateur ou appareil, lors de la synchronisation via l'attribut availableChannels. Cette liste doit comprendre toutes les chaînes populaires ou les plus regardées auxquelles l'utilisateur ou l'appareil sont abonnés. Pour garantir une faible latence des requêtes, nous vous recommandons de limiter la taille de la liste des chaînes (30 chaînes ou moins).

ATTRIBUTS de l'appareil

Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Fulfillment d'intent.

Attributs Type Description
availableChannels Array

Obligatoire.

Liste des objets décrivant les chaînes multimédias disponibles pour cet appareil spécifique. Chaque élément décrit une chaîne que l'utilisateur peut sélectionner sur cet appareil.
[item, ...] Objet

Canal média disponible.
key String

Obligatoire.

Identifiant unique de ce canal. Non visible par les utilisateurs.
names Array

Obligatoire.

Liste des noms visibles par l'utilisateur pour ce canal.
[item, ...] String

Le nom de la chaîne
number String

Identifiant numérique facultatif pour ce canal.
commandOnlyChannels Valeur booléenne

(Par défaut : false)

Indique si l'appareil est compatible avec la communication unidirectionnelle (true) ou bidirectionnelle (false). Définissez cet attribut sur "true" si l'appareil ne peut pas répondre à une intention QUERY ni à un rapport d'état pour cette caractéristique.

Exemples

Appareil compatible avec deux canaux.

{
  "availableChannels": [
    {
      "key": "ktvu2",
      "names": [
        "Fox",
        "KTVU"
      ],
      "number": "2"
    },
    {
      "key": "abc1",
      "names": [
        "ABC",
        "ABC East"
      ],
      "number": "4-11"
    }
  ]
}

ÉTATS des appareils

Aucune.

COMMANDES de l'appareil

Les appareils dotés de ce trait 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 Fulfillment d'intent.

action.devices.commands.selectChannel

Définissez le canal actuel sur une valeur spécifique.

Paramètres

La charge utile contient l'un des éléments suivants :

Sélectionner une chaîne par ID

Paramètres Type Description
channelCode String

Obligatoire.

Identifiant unique du canal demandé, correspondant à l'un des availableChannels.
channelName String

Nom convivial du canal demandé.
channelNumber String

Identifiant numérique du canal demandé.

Sélectionner une chaîne par son numéro

Paramètres Type Description
channelNumber String

Obligatoire.

Identifiant numérique du canal demandé.

Exemples

Passer à KTVU

{
  "command": "action.devices.commands.selectChannel",
  "params": {
    "channelCode": "ktvu2",
    "channelName": "KTVU"
  }
}

Mets la chaîne 3.

{
  "command": "action.devices.commands.selectChannel",
  "params": {
    "channelNumber": "3"
  }
}

Une erreur s'est produite lors de la sélection d'une nouvelle chaîne sur l'appareil.

Valeurs acceptées :

noAvailableChannel
noChannelSubscription
channelSwitchFailed

action.devices.commands.relativeChannel

Ajustez le canal actuel d'un montant relatif.

Paramètres

Paramètres Type Description
relativeChannelChange Entier

Obligatoire.

Nombre de canaux à augmenter ou à diminuer.

Exemples

Passer à la chaîne suivante

{
  "command": "action.devices.commands.relativeChannel",
  "params": {
    "relativeChannelChange": 1
  }
}

Passer à la chaîne précédente

{
  "command": "action.devices.commands.relativeChannel",
  "params": {
    "relativeChannelChange": -1
  }
}

Une erreur s'est produite lors du réglage de la chaîne de l'appareil.

Valeurs acceptées :

channelSwitchFailed

action.devices.commands.returnChannel

Revenir à la dernière chaîne consultée par l'utilisateur

Paramètres

Paramètres Type Description

Aucune propriété

Exemples

Revenir à la dernière chaîne

{
  "command": "action.devices.commands.returnChannel",
  "params": {}
}

Une erreur s'est produite lors du retour à la dernière chaîne de l'appareil.

Valeurs acceptées :

channelSwitchFailed

ERREURS liées à l'appareil

Consultez la liste complète des erreurs et exceptions.