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

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

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

デバイスの属性

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

属性	タイプ	説明
availableChannels	配列	必須。 このデバイスで使用可能なメディア チャネルを記述するオブジェクトのリスト。各アイテムは、ユーザーがこのデバイスで選択できるチャンネルを表します。
[item, ...]	オブジェクト	利用可能なメディア チャネル。
key	文字列	必須。 このチャンネルの一意の識別子。ユーザーには公開されません。
names	配列	必須。 このチャンネルのユーザーに表示される名前のリスト。
[item, ...]	文字列	チャンネル名
number	文字列	このチャネルの数値 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	文字列	必須。 リクエストされたチャンネルの一意の識別子（availableChannels のいずれかに一致する）。
channelName	文字列	リクエストされたチャンネルのわかりやすい名前。
channelNumber	文字列	リクエストされたチャネルの数値識別子。

番号でチャンネルを選択

パラメータ	タイプ	説明
channelNumber	文字列	必須。 リクエストされたチャネルの数値識別子。

例

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

デバイスエラー

エラーと例外のリストをご覧ください。