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 请求将导致给定的指示灯闪烁几次