Smart-Home-Channel-Trait-Schema

action.devices.traits.Channel : Dieses Trait gehört zu Geräten, die TV-Kanäle auf einem Mediengerät unterstützen.

Die verfügbaren Kanäle sollten während der SYNC-Antwort über das Attribut availableChannels als Liste pro Nutzer oder Gerät geteilt werden. Diese Liste sollte alle Top- oder beliebten Kanäle enthalten, die der Nutzer oder das Gerät abonniert hat. Damit die Abfragelatenz niedrig bleibt, empfehlen wir, die Kanalliste kurz zu halten (maximal 30 Kanäle).

Geräteattribute

Geräte mit diesem Trait können die folgenden Attribute als Teil des SYNC Vorgangs melden. Weitere Informationen zur Verarbeitung von SYNC Intents finden Sie unter Intent-Erfüllung.

Attribute Typ Beschreibung
availableChannels Array

Erforderlich.

Liste von Objekten, die die verfügbaren Medienkanäle für dieses 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 Kanal. Wird Nutzern nicht angezeigt.
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 Einweg- (true) oder Zweiwegkommunikation (false) unterstützt. Setzen Sie dieses Attribut auf „true“, wenn das Gerät nicht auf einen QUERY-Intent oder einen Report State für dieses Trait 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ätestatus

Keine.

Gerätebefehle

Geräte mit diesem Trait können im Rahmen des EXECUTE Vorgangs auf die folgenden Befehle antworten. Weitere Informationen zur Verarbeitung von EXECUTE Intents finden Sie unter Intent-Erfüllung.

action.devices.commands.selectChannel

Legt den aktuellen Kanal auf einen bestimmten Wert fest.

Parameter

Die Nutzlast enthält einen der folgenden Werte:

Kanal nach ID auswählen

Parameter Typ Beschreibung
channelCode String

Erforderlich.

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

Nutzerfreundlicher Name des angeforderten Kanals.
channelNumber String

Numerische Kennung für den angeforderten Kanal.

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"
  }
}

Zu Kanal 3 wechseln

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

Beim Auswählen eines neuen Kanals auf dem Gerät ist ein Fehler aufgetreten.

Unterstützte Werte:

noAvailableChannel
noChannelSubscription
channelSwitchFailed

action.devices.commands.relativeChannel

Passt den aktuellen Kanal um einen relativen Betrag an.

Parameter

Parameter Typ Beschreibung
relativeChannelChange Ganzzahl

Erforderlich.

Die Anzahl der Kanäle, um 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

Kehrt zum letzten/vorherigen Kanal zurück, auf dem der Nutzer war.

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Zum letzten Kanal zurückkehren

{
  "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

Vollständige Liste der Fehler und Ausnahmen ansehen