Schéma de traits de chaîne pour la maison connectée

action.devices.traits.Channel : cette caractéristique appartient aux appareils compatibles avec les chaînes de télévision sur un appareil multimédia.

Les canaux disponibles doivent être partagés sous forme de liste, par utilisateur ou par appareil, pendant la synchronisation via l'attribut availableChannels. Cette liste doit inclure toutes les chaînes populaires ou les plus populaires auxquelles l'utilisateur ou l'appareil est abonné. Pour garantir une faible latence de requête, nous vous recommandons de limiter la liste des canaux (à 30 canaux ou moins).

ATTRIBUTS de l'appareil

Les appareils présentant cette caractéristique peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez la section Traitement des intents.

Attributs Type Description
availableChannels Array

Obligatoire.

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

Canal multimédia disponible.
key String

Obligatoire.

Identifiant unique de cette chaîne. Non exposée aux utilisateurs.
names Array

Obligatoire.

Liste des noms visibles par l'utilisateur pour cette chaîne.
[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 prend en charge la communication à sens unique (true) ou à double sens (false). Définissez cet attribut sur "true" si l'appareil ne peut pas répondre à un intent QUERY ou à un état de rapport 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 DE L'APPAREIL

Aucune.

COMMANDS d'appareils

Les appareils dotés 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 la section Traitement des intents.

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 de la chaîne demandée.
channelNumber String

Identifiant numérique du canal demandé.

Sélectionner une chaîne par numéro

Paramètres Type Description
channelNumber String

Obligatoire.

Identifiant numérique du canal demandé.

Exemples

Changement vers KTVU

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

Passez à 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'une valeur relative.

Paramètres

Paramètres Type Description
relativeChannelChange Entier

Obligatoire.

Nombre de canaux à augmenter ou à réduire.

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 de l'ajustement de la version de l'appareil.

Valeurs acceptées :

channelSwitchFailed

action.devices.commands.returnChannel

Revenir à la dernière/précédente chaîne sur laquelle l'utilisateur se trouvait.

Paramètres

Paramètres Type Description

Aucune propriété

Exemples

Revenir à la chaîne précédente

{
  "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 d'appareil

Consultez la liste complète des erreurs et exceptions.