智慧家庭頻道交易結構定義

action.devices.traits.Channel - 這個特性代表的是媒體裝置上支援電視頻道的裝置。

在 Sync 中，透過 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

裝置 ERRORS

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