スマートホームの Channel トレイトのスキーマ

action.devices.traits.Channel - このトレイトは、メディア デバイスでテレビ チャンネルをサポートするデバイスに使用します。

SYNC 中は、availableChannels 属性を使用して、ユーザーまたはデバイスごとに、利用可能なチャネルをリストとして共有する必要があります。このリストには、ユーザーまたはデバイスが登録している人気のチャンネルまたは人気のチャンネルをすべて含める必要があります。クエリのレイテンシを低くするには、チャンネル リストを小さく（30 チャンネル以下）することをおすすめします。

デバイスの属性

このトレイトを持つデバイスは、SYNC オペレーションの一部として次の属性を報告できます。SYNC インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
availableChannels 配列

必須。

このデバイスで使用可能なメディア チャネルを記述するオブジェクトのリスト。各アイテムは、ユーザーがこのデバイスで選択できるチャンネルを表します。
[item, ...] 温度計

利用可能なメディア チャンネル。
key String

必須。

このチャンネルの一意の識別子。ユーザーには公開されません。
names 配列

必須。

このチャンネルのユーザーに表示される名前のリスト。
[item, ...] String

チャンネル名
number String

このチャンネルの数値 ID（省略可）。
commandOnlyChannels ブール値

（デフォルト: false）

デバイスが一方向（True）または双方向（False）の通信に対応しているかどうかを示します。デバイスがこのトレイトの QUERY インテントまたは Report State に応答できない場合は、この属性を true に設定します。

例

2 つのチャンネルに対応するデバイス。

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

デバイスのステータス

なし。

デバイスのコマンド

このトレイトを持つデバイスは、EXECUTE オペレーションの一環として次のコマンドに応答できます。EXECUTE インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

action.devices.commands.selectChannel

現在のチャンネルを特定の値に設定します。

パラメータ

ペイロードには次のいずれかが含まれています。

ID でチャンネルを選択

パラメータ タイプ 説明
channelCode String

必須。

availableChannels のいずれかに一致する、リクエストされたチャネルの一意の識別子。
channelName String

リクエストされたチャネルのわかりやすい名前。
channelNumber String

リクエストされたチャネルの数値 ID。

番号でチャンネルを選択

パラメータ タイプ 説明
channelNumber String

必須。

リクエストされたチャネルの数値 ID。

例

KTVU に変更する

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

チャンネル 3 を見る。

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

デバイスで新しいチャンネルの選択中にエラーが発生しました。

サポートされる値:

noAvailableChannel
noChannelSubscription
channelSwitchFailed

action.devices.commands.relativeChannel

現在のチャンネルを相対値で調整します。

パラメータ

パラメータ タイプ 説明
relativeChannelChange Integer

必須。

増減するチャネル数。

例

次のチャンネルに切り替える

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

前のチャンネルに切り替える

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

デバイスのチャンネル調整中にエラーが発生しました。

サポートされる値:

channelSwitchFailed

action.devices.commands.returnChannel

ユーザーが見ていた最後の/前のチャンネルに戻ります。

パラメータ

パラメータ タイプ 説明

プロパティがありません

例

前のチャンネルに戻る

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

デバイスの最後のチャンネルに戻る際にエラーが発生しました。

サポートされる値:

channelSwitchFailed

デバイスエラー

エラーと例外の全一覧をご覧ください。