Das Elgato Key Light und das Key Light Air sind kantenbeleuchtete LED-Videoleuchten, die bei Live-Streamern auf Plattformen wie Twitch beliebt sind. Diese Leuchten sind IoT-Geräte und werden normalerweise mit der „Control Center“-App von Elgato oder über eines der Stream Deck-Geräte (ebenfalls von Elgato hergestellt) gesteuert. Die Key Light-Geräte unterstützen nicht nativ die Integration von Drittanbietern, können aber durch direkte Anbindung an die integrierte API der Leuchten gesteuert werden.
Die „Control Center“-App sendet Befehle über HTTP an Key Light-Geräte, mit denen sie verknüpft ist. Die in diesem Dokument definierten API-Anfragen wurden mit Wireshark und Referenzversion 1.1.2 der Elgato-App „Control Center“ (Windows 10) gefunden.
Nach dem Hinzufügen zu einem Netzwerk erhalten Key Light-Geräte wahrscheinlich IP-Adressen von einem Router über DHCP. Spezifische IP-Adressen können vom DHCP-Server/Netzwerkrouter bezogen werden, sind aber auch in der „Control Center“-App leicht zugänglich. Gehen Sie dazu wie folgt vor:
Accessory settings
(in Form eines Schiebereglers) neben dem Namen eines GerätsAdvanced
. Die IP-Adresse wird unter „Einschaltverhalten“ und „Firmware-Version“ angezeigtKey Light-Geräte warten auf Befehle auf Port 9123 .
Alle Anfragen sollten an /elgato
gesendet werden.
Rufen Sie die aktuellen Einstellungen eines Geräts ab:
curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'
Key Light-Geräte erfordern keine Authentifizierung.
Key Light-Geräte geben nur zwei HTTP-Statuscodes zurück:
200 OK
Die Anfrage war erfolgreich.400 Bad Request
Die Anfrage wurde vom Gerät nicht verstanden (wahrscheinlich aufgrund einer fehlerhaften Syntax)Darüber hinaus sind alle von einem Gerät zurückgegebenen Daten JSON-formatiert.
Es gibt nur drei Ressourcen, die von der Key Light API implementiert werden
lights
Lichterobjekte enthalten Informationen zum aktuellen Status, zur Helligkeit und zur Farbtemperatur eines Key Light-Gerätsaccessory-info
-Objekte enthalten Informationen zu den physischen Hardware-Spezifikationen eines Key Light-Gerätssettings
enthalten Informationen zum Verhalten eines Key Light-Geräts Es gibt eine „Aktion“, die von der Key Light API implementiert wird:
identify
das Senden einer HTTP-POST-Anfrage an diesen Endpunkt dazu führt, dass das angegebene Licht einige Male blinkt