Les Elgato Key Light et Key Light Air sont des lampes vidéo LED à éclairage périphérique qui sont populaires auprès des streamers en direct sur des plateformes comme Twitch. Ces lumières sont des appareils IoT et sont normalement contrôlées avec l'application « Control Center » d'Elgato ou via l'un des appareils Stream Deck (également fabriqués par Elgato). Les appareils Key Light ne prennent pas en charge nativement l'intégration tierce, mais ils peuvent être contrôlés en s'interfaçant directement avec l'API intégrée des lumières.
L'application « Control Center » envoie des commandes aux appareils Key Light auxquels elle a été associée via HTTP. Les requêtes API définies dans ce document ont été trouvées à l'aide de Wireshark et de la version de référence 1.1.2 de l'application Elgato « Control Center » (Windows 10).
Après avoir été ajoutés à un réseau, les appareils Key Light reçoivent probablement des adresses IP d'un routeur via DHCP. Des adresses IP spécifiques peuvent être extraites du serveur DHCP/routeur réseau, mais elles sont également facilement accessibles dans l'application « Control Center ». Pour ce faire :
Accessory settings (en forme de curseur) à côté du nom d'un appareil.Advanced . L'adresse IP sera présentée sous Comportement à la mise sous tension et version du micrologicielLes appareils Key Light écoutent les commandes sur le port 9123 .
Toutes les demandes doivent être envoyées à /elgato .
Obtenez les paramètres actuels d'un appareil :
curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'
Les appareils Key Light ne nécessitent pas d’authentification.
Les appareils Key Light ne renvoient que deux codes d'état HTTP :
200 OK La requête a réussi.400 Bad Request La requête n'a pas été comprise par l'appareil (probablement en raison d'une syntaxe mal formée)De plus, toutes les données renvoyées par un appareil seront au format JSON.
Il n'y a que trois ressources implémentées par l'API Key Light
lights Les objets lumières contiennent des informations relatives à l'état actuel, à la luminosité et à la température de couleur d'un appareil Key Light.accessory-info accessoire-info contiennent des informations relatives aux spécifications matérielles physiques d'un périphérique Key Light.settings contiennent des informations liées au comportement d'un appareil Key Light Il existe une « action » implémentée par l’API Key Light :
identify l'envoi d'une requête HTTP POST à ce point de terminaison fera clignoter le voyant donné plusieurs fois
