Smart-Home-Set-Top-Box-Leitfaden
action.devices.types.SETTOP – Interaktionen mit Multichannel Video Programming Distributor (MVPD) und Set-Top-Boxen können die Steuerung der Medienwiedergabe umfassen.
Dieser Typ zeigt an, dass das Gerät das Set-Top-Box-Symbol und einige zugehörige Synonyme und Aliasse erhält.
Gerätefunktionen
In der zugehörigen Dokumentation zur Eigenschaft finden Sie Implementierungsdetails wie Attribute und Status, die Ihr Dienst unterstützen sollte, und zum Erstellen von EXECUTE- und QUERY-Antworten.
Erforderliche Eigenschaften
Diese Eigenschaften und Befehle sind erforderlich, falls sie auf Ihr Gerät zutreffen. Wenn Ihr Gerät diese Eigenschaften nicht unterstützt, geben Sie den Fehlercode functionNotSupported in einer QUERY- oder EXECUTE-Antwort ein. Weitere Informationen finden Sie unter Fehler und Ausnahmen.
| Merkmal | Befehle |
|---|---|
action.devices.traits.AppSelector |
|
action.devices.traits.InputSelector |
|
action.devices.traits.MediaState |
|
action.devices.traits.OnOff |
|
action.devices.traits.TransportControl |
|
action.devices.traits.Volume |
|
Empfohlene Eigenschaften
Diese Eigenschaften werden empfohlen, sofern sie für Ihr Gerät relevant sind. Sie können jedoch alle verfügbaren Merkmale beliebig kombinieren, um Ihre bestehenden Produktfunktionen bestmöglich anzupassen.
Qualitätsanforderungen
- Latenz: muss kleiner oder gleich 3.000 ms sein.
- Zuverlässigkeit:muss größer oder gleich 97% sein
Beispielgerät: Einfache Set-Top-Box
Dieser Abschnitt enthält Beispiel-Nutzlasten, die eine gängige „Set-Top-Box“ basierend auf dem oben genannten Gerätetyp und den Merkmalen darstellen. Wenn du bei der Implementierung Eigenschaften hinzufügst oder entfernst, ändere deine Antworten entsprechend.
SYNC-Beispielantwort
{
"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"
}
}
]
}
}
Beispiel für eine QUERY-Antwort
{
"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"
}
}
}
}
Beispiele für EXECUTE-Befehle
An
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
}
}
]
}
}
App-Installation
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}
Kanal auswählen
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
}
}
]
}
}
relativeKanal
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
}
}
]
}
}
Rückgabekanal
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
}
}
]
}
}
mediaUntertitelUntertitelAus
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}
Medienuntertitel aktiviert
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}
Medien zurück
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}
Wiederaufnahme
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}
Logo: mediaStop
Weitere Informationen zu den Befehlsparametern finden Sie in der
Referenz zu 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"
}
}
]
}
}