Smart-Home-Channel-Attributschema

action.devices.traits.Channel: Diese Eigenschaft bezieht sich auf Geräte, die TV-Kanäle auf einem Mediengerät unterstützen.

Die verfügbaren Kanäle sollten während der SYNCHRONISIERUNG über das Attribut availableChannels als Liste pro Nutzer oder Gerät freigegeben werden. Diese Liste sollte alle Top- oder beliebten Kanäle enthalten, die der Nutzer oder das Gerät abonniert hat. Um eine geringe Abfragelatenz zu gewährleisten, empfehlen wir, die Kanalliste klein zu halten (maximal 30 Kanäle).

Geräte-ATTRIBUTES

Geräte mit diesem Merkmal können die folgenden Attribute als Teil des SYNC-Vorgangs melden. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Ausführung.

Attribute Typ Beschreibung
availableChannels Array

Erforderlich.

Liste der Objekte, die die verfügbaren Medienkanäle für dieses bestimmte Gerät beschreiben. Jedes Element beschreibt einen Kanal, den der Nutzer auf diesem Gerät auswählen kann.
[item, ...] Objekt

Verfügbarer Medienkanal.
key String

Erforderlich.

Eindeutige Kennung für diesen Channel. Nicht für Nutzer sichtbar.
names Array

Erforderlich.

Liste der für Nutzer sichtbaren Namen für diesen Kanal.
[item, ...] String

Kanalname
number String

Optionale numerische Kennung für diesen Kanal.
commandOnlyChannels Boolesch

(Standardeinstellung: false)

Gibt an, ob das Gerät die unidirektionale (wahr) oder bidirektionale (falsch) Kommunikation unterstützt. Legen Sie dieses Attribut auf „true“ fest, wenn das Gerät nicht auf eine QUERY-Intention oder den Berichtsstatus für dieses Attribut antworten kann.

Beispiele

Gerät, das zwei Kanäle unterstützt

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

Gerät: STATES

Keine.

Gerät "COMMANDS"

Geräte mit diesem Merkmal können im Rahmen des EXECUTE-Vorgangs auf die folgenden Befehle reagieren. Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Intent-Ausführung.

action.devices.commands.selectChannel

Legen Sie einen bestimmten Wert für den aktuellen Kanal fest.

Parameter

Die Nutzlast enthält Folgendes:

Channel nach ID auswählen

Parameter Typ Beschreibung
channelCode String

Erforderlich.

Eindeutige Kennung für den angeforderten Kanal, die mit einer der availableChannels übereinstimmt.
channelName String

Nutzerfreundlicher Name des angeforderten Kanals.
channelNumber String

Numerische Kennung des angeforderten Kanals.

Kanal nach Nummer auswählen

Parameter Typ Beschreibung
channelNumber String

Erforderlich.

Numerische Kennung für den angeforderten Kanal.

Beispiele

Zu KTVU wechseln

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

Wechseln Sie zu Kanal 3.

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

Bei der Auswahl eines neuen Kanals auf dem Gerät ist ein Fehler aufgetreten.

Unterstützte Werte:

noAvailableChannel
noChannelSubscription
channelSwitchFailed

action.devices.commands.relativeChannel

Den aktuellen Kanal um einen relativen Wert anpassen.

Parameter

Parameter Typ Beschreibung
relativeChannelChange Ganzzahl

Erforderlich.

Die Anzahl der Kanäle, die erhöht oder verringert werden soll.

Beispiele

Zum nächsten Kanal wechseln

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

Zum vorherigen Kanal wechseln

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

Beim Anpassen des Kanals des Geräts ist ein Fehler aufgetreten.

Unterstützte Werte:

channelSwitchFailed

action.devices.commands.returnChannel

Zum letzten/vorherigen Kanal zurückkehren, auf dem sich der Nutzer befand.

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Zurück zum letzten Kanal

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

Beim Zurückkehren zum letzten Kanal des Geräts ist ein Fehler aufgetreten.

Unterstützte Werte:

channelSwitchFailed

GERÄTEFEHLER

Eine vollständige Liste der Fehler und Ausnahmen