Leitfaden für Smart-Home-Streaming-Boxen
action.devices.types.STREAMING_BOX: Dieses Gerät ermöglicht Streamingdienste für Medien und Musik, die häufig in Verbindung mit einem Display wie einem Fernseher verwendet werden. Dieses Gerät wird von einer konstanten Quelle mit Strom versorgt, unabhängig vom Anzeigegerät selbst.
Dieser Typ gibt an, dass das Gerät das Streaming Box-Symbol und einige zugehörige Synonyme und Aliasse erhält.
Gerätefunktionen
Informationen zur Implementierung finden Sie in der entsprechenden Trait-Dokumentation, z. B. zu Attributen und Statusangaben, die Ihr Dienst unterstützen sollte, und zum Erstellen von EXECUTE- und QUERY-Antworten.
Erforderliche Merkmale
Diese Merkmale und Befehle sind bei Bedarf für Ihr Gerät erforderlich. Wenn dein Gerät diese Traits nicht unterstützt, gib den Fehlercode functionNotSupported in einer QUERY- oder EXECUTE-Antwort ein. Weitere Informationen finden Sie unter Fehler und Ausnahmen.
-
action.devices.traits.AppSelector -
action.devices.traits.MediaState -
action.devices.traits.OnOff -
action.devices.traits.TransportControl -
action.devices.traits.Volume
Empfohlene Eigenschaften
Diese Traits werden empfohlen, sofern für Ihr Gerät zutreffend. Sie können jedoch alle verfügbaren Merkmale beliebig kombinieren, um der vorhandenen Produktfunktionalität am besten zu entsprechen.
Qualitätsanforderungen
- Latenz:muss kleiner oder gleich 3.000 ms sein.
- Zuverlässigkeit: muss größer oder gleich 97% sein.
Beispielgerät: Einfache Streaming-Box
Dieser Abschnitt enthält Beispiel-Intent-Nutzlasten, die basierend auf dem oben genannten Gerätetyp und den obigen Eigenschaften eine gemeinsame "Streaming Box" darstellen. Wenn Sie in Ihrer Implementierung Traits hinzufügen oder entfernen, passen Sie Ihre Antworten entsprechend an.
Beispiel für SYNC-Antwort
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.STREAMING_BOX",
"traits": [
"action.devices.traits.AppSelector",
"action.devices.traits.MediaState",
"action.devices.traits.OnOff",
"action.devices.traits.TransportControl",
"action.devices.traits.Volume"
],
"name": {
"name": "Simple streaming box"
},
"willReportState": true,
"attributes": {
"availableApplications": [
{
"key": "youtube",
"names": [
{
"name_synonym": [
"YouTube"
],
"lang": "en"
}
]
}
],
"transportControlSupportedCommands": [
"NEXT",
"PREVIOUS",
"PAUSE",
"STOP",
"RESUME"
],
"volumeMaxLevel": 11,
"volumeCanMuteAndUnmute": true,
"supportActivityState": true,
"supportPlaybackState": true
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
Beispiel für 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",
"currentVolume": 10,
"isMuted": false,
"activityState": "ACTIVE",
"playbackState": "PAUSED"
}
}
}
}
Beispiele für EXECUTE-Befehle
appInstall
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.AppSelector.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appInstall",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"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": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSearch",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"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": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSelect",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
OnOff
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.OnOff.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}
mediaClosedCaptioningOff
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOff"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaClosedCaptioningOn
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOn",
"params": {
"closedCaptioningLanguage": "en"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"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": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaNext"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654528",
"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": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PAUSED"
}
}
]
}
}
mediaPrevious
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.mediaPrevious"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "REWINDING"
}
}
]
}
}
mediaResume
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.mediaResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654534",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaStop
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.mediaStop"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654536",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "STOPPED"
}
}
]
}
}
Stummschalten
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.Volume.
{
"requestId": "6894439706274654540",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mute",
"params": {
"mute": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654540",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentVolume": 10,
"isMuted": true
}
}
]
}
}
setVolume
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.Volume.
{
"requestId": "6894439706274654538",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.setVolume",
"params": {
"volumeLevel": 11
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654538",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentVolume": 11,
"isMuted": false
}
}
]
}
}