智慧型住宅頻道特徵結構定義

action.devices.traits.Channel：這個特徵屬於在媒體裝置上支援電視頻道的裝置。

在同步處理期間，應透過 availableChannels 屬性，將可用的管道以清單形式分享給每位使用者或裝置。這份清單應包含使用者或裝置訂閱的所有熱門或熱門頻道。為確保查詢延遲時間低，建議您將管道清單保持在較小 (30 個管道以下)。

裝置屬性

具備此特徵的裝置可能會在 SYNC 作業中回報下列屬性。如要進一步瞭解如何處理 SYNC 意圖，請參閱「意圖執行要求」。

屬性 類型 說明
availableChannels 陣列

必填。

描述此特定裝置可用媒體管道的物件清單。每個項目都會說明使用者可在這個裝置上選取的頻道。
[item, ...] 物件

可用的媒體管道。
key String

必要。

這個管道的專屬 ID。不會向使用者顯示。
names 陣列

必填。

這個管道的使用者可見名稱清單。
[item, ...] String

頻道名稱。
number String

這個管道的選用數字 ID。
commandOnlyChannels 布林值

(預設值：false)

指出裝置是否支援使用單向 (true) 或雙向 (false) 通訊。如果裝置無法回應此特徵的 QUERY 意圖或回報狀態，請將這個屬性設為 true。

範例

支援兩個聲道的裝置。

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

必填。

要求的管道專屬 ID，與 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

裝置錯誤

請參閱錯誤和例外狀況的完整清單。