Elgato Key Light 和 Key Light Air 是側光式 LED 視訊燈,深受 Twitch 等平台上的直播主播的歡迎。這些燈是物聯網設備,通常透過 Elgato 的「控制中心」應用程式或透過其中一種 Stream Deck 設備(也由 Elgato 製造)進行控制。 Key Light 設備本身不支援第三方集成,但可以透過直接與燈光的內建 API 連接來控制它們。
「控制中心」應用程式透過 HTTP 將命令傳送至與其關聯的 Key Light 裝置。本文檔中定義的 API 請求是使用 Wireshark 和 Elgato「控制中心」應用程式 (Windows 10) 的參考版本 1.1.2 找到的。
新增至網路後,Key Light 裝置可能會透過 DHCP 從路由器接收 IP 位址。可以從 DHCP 伺服器/網路路由器取得特定的 IP 位址,但也可以在「控制中心」應用程式中輕鬆存取它們。為此:
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 裝置僅傳回兩個 HTTP 狀態碼:
200 OK
請求成功。400 Bad Request
設備無法理解該請求(可能是由於語法格式錯誤)此外,裝置傳回的任何資料都將採用 JSON 格式。
Key Light API 只實作了三個資源
lights
物件包含與關鍵燈光設備的當前狀態、亮度和色溫相關的訊息accessory-info
資訊物件包含與 Key Light 設備的實體硬體規格相關的信息settings
設定物件包含與 Key Light 裝置行為相關的訊息Key Light API 實作了一個「操作」:
identify
向此端點發送 HTTP POST 請求將導致給定的指示燈閃爍幾次