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

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

Turn to channel three.

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

裝置錯誤

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