スマートホーム セットトップ ボックス ガイド
action.devices.types.SETTOP - マルチチャンネル動画番組配信会社（MVPD）やセットトップ ボックス デバイスとの連携には、メディア再生の制御が含まれる場合があります。
このタイプのデバイスにはセットトップ ボックスのアイコンと関連するアイコンが割り当てられることを示します。 類義語と別名を使用します。
デバイスの機能
詳しくは、対応するトレイトのドキュメントをご覧ください。 実装の詳細（サービスがサポートする必要がある属性と状態、 EXECUTE レスポンスと QUERY レスポンスを作成します。
必要なトレイト
以下のトレイトとコマンドは必須です（
できます。デバイスがこれらのトレイトをサポートしていない場合は、次のエラーコードを入力してください。
QUERY または EXECUTE レスポンスの functionNotSupported。詳しくは、
エラーと例外をご覧ください。
| トレイト | コマンド |
|---|---|
action.devices.traits.AppSelector |
|
action.devices.traits.InputSelector |
|
action.devices.traits.MediaState |
|
action.devices.traits.OnOff |
|
action.devices.traits.TransportControl |
|
action.devices.traits.Volume |
|
推奨されるトレイト
お使いのデバイスに応じて、以下のトレイトを使用することをおすすめします。 ただし、利用可能なすべてのトレイトの中から、既存のテクノロジーに合わせて自由に組み合わせて使用することができます。 提供します。
品質要件
- レイテンシ: 3,000 ミリ秒以下
- 信頼性: 97% 以上にする必要があります。
デバイスの例: シンプルなセットトップ ボックス
このセクションでは、一般的な「セットトップ ボックス」を表すインテント ペイロードの例を示します。 デバイスは上記のデバイスタイプとトレイトに基づきます。実装でトレイトを追加または削除すると、 変更に合わせて回答を修正してください。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.SETTOP",
"traits": [
"action.devices.traits.OnOff",
"action.devices.traits.AppSelector",
"action.devices.traits.MediaState",
"action.devices.traits.Channel",
"action.devices.traits.TransportControl"
],
"name": {
"name": "Simple set-top box"
},
"willReportState": true,
"attributes": {
"transportControlSupportedCommands": [
"NEXT",
"PREVIOUS",
"PAUSE",
"STOP",
"RESUME",
"CAPTION_CONTROL"
],
"availableApplications": [
{
"key": "youtube",
"names": [
{
"name_synonym": [
"Youtube",
"Youtube_en"
],
"lang": "en"
}
]
}
],
"availableChannels": [
{
"key": "ktvu2",
"names": [
"Fox",
"KTVU"
],
"number": "2"
},
{
"key": "abc1",
"names": [
"ABC",
"ABC East"
],
"number": "702.4-11"
}
],
"supportActivityState": true,
"supportPlaybackState": true
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
QUERY レスポンスの例
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": true,
"currentApplication": "youtube",
"activityState": "ACTIVE",
"playbackState": "PAUSED"
}
}
}
}
EXECUTE コマンドの例
OnOff
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.OnOff
ご覧ください。
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}
appInstall
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.AppSelector
ご覧ください。
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appInstall",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
appSearch
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.AppSelector
ご覧ください。
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSearch",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
appSelect
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.AppSelector
ご覧ください。
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSelect",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
selectChannel
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.Channel
ご覧ください。
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.selectChannel",
"params": {
"channelCode": "ktvu2"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
relativeChannel
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.Channel
ご覧ください。
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.relativeChannel",
"params": {
"relativeChannelChange": 1
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
returnChannel
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.Channel
ご覧ください。
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.returnChannel"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true
}
}
]
}
}
mediaClosedCaptioningOff
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOff"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaClosedCaptioningOn
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOn",
"params": {
"closedCaptioningLanguage": "en"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaNext
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654534",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaNext"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654534",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "FAST_FORWARDING"
}
}
]
}
}
mediaPause
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654536",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654536",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PAUSED"
}
}
]
}
}
mediaPrevious
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654538",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPrevious"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654538",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "REWINDING"
}
}
]
}
}
mediaResume
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654540",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654540",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaStop
コマンド パラメータの詳細については、
<ph type="x-smartling-placeholder"></ph>をご覧ください
action.devices.traits.TransportControl
ご覧ください。
{
"requestId": "6894439706274654542",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaStop"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654542",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "STOPPED"
}
}
]
}
}