Elgato Key Light と Key Light Air は、Twitch などのプラットフォームのライブストリーマーに人気のあるエッジライト LED ビデオ ライトです。これらのライトは IoT デバイスであり、通常は Elgato の「コントロール センター」アプリまたは Stream Deck デバイス (これも Elgato 製) の 1 つを通じて制御されます。 Key Light デバイスはサードパーティの統合をネイティブにサポートしていませんが、ライトの組み込み API と直接接続することで制御できます。
「コントロール センター」アプリは、関連付けられている Key Light デバイスに HTTP 経由でコマンドを送信します。このドキュメントで定義されている API リクエストは、Wireshark および Elgato 'コントロール センター' アプリ (Windows 10) の参照バージョン 1.1.2 を使用して見つかりました。
Key Light デバイスは、ネットワークに追加された後、DHCP 経由でルーターから IP アドレスを受け取る可能性があります。特定の IP アドレスは DHCP サーバー/ネットワーク ルーターから取得できますが、「コントロール センター」アプリからも簡単にアクセスできます。これを行うには:
Accessory settings
アイコン (スライダーのような形) をクリックします。Advanced
セクションを展開します。 IP アドレスは、電源投入時の動作とファームウェアのバージョンの下に表示されます。Key Light デバイスは、ポート9123でコマンドを待機します。
すべてのリクエストは/elgato
に送信される必要があります。
デバイスの現在の設定を取得します。
curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'
Key Light デバイスには認証は必要ありません。
Key Light デバイスは 2 つの HTTP ステータス コードのみを返します。
200 OK
リクエストは成功しました。400 Bad Request
リクエストはデバイスによって理解されませんでした (おそらく構文の形式が間違っているため)さらに、デバイスから返されるデータはすべて JSON 形式になります。
Key Light API によって実装されるリソースは 3 つだけです
lights
ライト オブジェクトには、キー ライト デバイスの現在の状態、明るさ、色温度に関連する情報が含まれていますaccessory-info
アクセサリ情報オブジェクトには、Key Light デバイスの物理ハードウェア仕様に関連する情報が含まれていますsettings
設定オブジェクトには、Key Light デバイスの動作に関連する情報が含まれていますKey Light API によって実装される「アクション」が 1 つあります。
identify
します