Guide de la clé de streaming pour maison connectée
action.devices.types.STREAMING_STICK : cet appareil est doté d'un petit format en forme de stick, généralement alimenté par un câble USB ou HDMI connecté à un écran, comme un téléviseur.
Ce type indique que l'appareil obtient l'icône Stick de streaming, ainsi que des synonymes et alias associés.
Fonctionnalités de l'appareil
Consultez la documentation sur les caractéristiques correspondantes pour obtenir des détails sur l'implémentation, tels que les attributs et les états que votre service doit accepter, et pour découvrir comment créer des réponses EXECUTE et QUERY.
Caractéristiques obligatoires
Ces caractéristiques et commandes sont nécessaires, le cas échéant. Si votre appareil n'est pas compatible avec ces caractéristiques, saisissez le code d'erreur functionNotSupported dans une réponse QUERY ou EXECUTE. Pour en savoir plus, consultez Erreurs et exceptions.
-
action.devices.traits.AppSelector -
action.devices.traits.MediaState -
action.devices.traits.TransportControl -
action.devices.traits.Volume
Caractéristiques recommandées
Ces caractéristiques sont recommandées, le cas échéant. Cependant, vous êtes libre de combiner toutes les caractéristiques disponibles pour correspondre au mieux aux fonctionnalités existantes de votre produit.
Exigences de qualité
- Latence:doit être inférieure ou égale à 3 000 ms.
- Fiabilité:doit être supérieure ou égale à 97%.
Exemple d'appareil: clé de streaming simple
Cette section contient des exemples de charges utiles d'intent représentant une clé de streaming courante basée sur le type d'appareil et les caractéristiques ci-dessus. Si vous ajoutez ou supprimez des caractéristiques dans votre mise en œuvre, modifiez vos réponses en conséquence.
Exemple de réponse SYNC
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.STREAMING_STICK",
"traits": [
"action.devices.traits.AppSelector",
"action.devices.traits.MediaState",
"action.devices.traits.TransportControl",
"action.devices.traits.Volume"
],
"name": {
"name": "Simple streaming stick"
},
"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"
}
}
]
}
}
Exemple de réponse QUERY
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"currentApplication": "youtube",
"currentVolume": 10,
"isMuted": false,
"activityState": "ACTIVE",
"playbackState": "PAUSED"
}
}
}
}
Exemples de commandes EXECUTE
Installation de l'application
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.AppSelector.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appInstall",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
Recherche d'applications
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.AppSelector.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSearch",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
Sélection d'applications
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.AppSelector.
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.appSelect",
"params": {
"newApplication": "youtube"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentApplication": "youtube"
}
}
]
}
}
mediaClosedCaptioningOff
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOff"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
mediaClosedCaptioningOn
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaClosedCaptioningOn",
"params": {
"closedCaptioningLanguage": "en"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
Élément multimédia suivant
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaNext"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "FAST_FORWARDING"
}
}
]
}
}
pause multimédia
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PAUSED"
}
}
]
}
}
médiaPrécédent
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaPrevious"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "REWINDING"
}
}
]
}
}
Reprise des contenus multimédias
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "PLAYING"
}
}
]
}
}
MediaStop
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.TransportControl.
{
"requestId": "6894439706274654534",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mediaStop"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654534",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"playbackState": "STOPPED"
}
}
]
}
}
couper le son
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.Volume.
{
"requestId": "6894439706274654538",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.mute",
"params": {
"mute": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654538",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentVolume": 10,
"isMuted": true
}
}
]
}
}
Régler le volume
Pour en savoir plus sur les paramètres de commande, consultez la documentation de référence sur
action.devices.traits.Volume.
{
"requestId": "6894439706274654536",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.setVolume",
"params": {
"volumeLevel": 11
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654536",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentVolume": 11,
"isMuted": false
}
}
]
}
}