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

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

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

デバイスの属性

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

属性 タイプ 説明
availableChannels 配列

必須。

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

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

必須。

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

必須。

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

チャンネル名
number String

このチャネルの数値識別子（省略可）。
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 整数

必須。

増減するチャンネルの数。

例

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

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

デバイスエラー

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