Guide des clés de streaming pour la maison connectée
action.devices.types.STREAMING_STICK : cet appareil est doté d'un petit facteur de forme en forme de stick, généralement alimenté par un câble USB ou HDMI connecté à un écran tel qu'un téléviseur.
Ce type indique que l'appareil obtient l'icône Streaming Stick, ainsi que certains synonymes et alias associés.
Fonctionnalités de l'appareil
Reportez-vous à la documentation sur les fonctionnalités correspondantes pour obtenir des détails sur l'implémentation, tels que les attributs et les états que votre service doit prendre en charge, et pour découvrir comment créer des réponses EXECUTE et QUERY.
Traits obligatoires
Ces traits et commandes sont requis, le cas échéant. Si votre appareil n'est pas compatible avec ces traits, saisissez le code d'erreur de functionNotSupported dans une réponse QUERY ou EXECUTE. Pour en savoir plus, consultez la section Erreurs et exceptions.
-
action.devices.traits.AppSelector -
action.devices.traits.MediaState -
action.devices.traits.TransportControl -
action.devices.traits.Volume
Traits recommandés
Ces traits sont recommandés s'ils s'appliquent à votre appareil. 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é
- La latence doit être inférieure ou égale à 3 000 ms.
- Fiabilité: la valeur 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 en fonction du type d'appareil et des caractéristiques décrites ci-dessus. Si vous ajoutez ou supprimez des caractéristiques dans votre implémentation, modifiez vos réponses en conséquence pour refléter ces modifications.
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
appInstall
Pour en savoir plus sur les paramètres de la 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"
}
}
]
}
}
appSearch
Pour en savoir plus sur les paramètres de la 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"
}
}
]
}
}
appSelect
Pour en savoir plus sur les paramètres de la 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 la 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 la 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"
}
}
]
}
}
mediaNext
Pour en savoir plus sur les paramètres de la 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"
}
}
]
}
}
mediaPause
Pour en savoir plus sur les paramètres de la 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"
}
}
]
}
}
mediaPrevious
Pour en savoir plus sur les paramètres de la 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"
}
}
]
}
}
mediaResume
Pour en savoir plus sur les paramètres de la 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 la 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 la 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
}
}
]
}
}
setVolume
Pour en savoir plus sur les paramètres de la 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
}
}
]
}
}