A Elgato Key Light e a Key Light Air são luzes de vídeo LED com iluminação lateral que são populares entre streamers ao vivo em plataformas como Twitch. Essas luzes são dispositivos IoT e normalmente são controladas com o aplicativo 'Control Center' da Elgato ou através de um dos dispositivos Stream Deck (também fabricados pela Elgato). Os dispositivos Key Light não oferecem suporte nativo à integração de terceiros, mas podem ser controlados pela interface direta com a API integrada das luzes.
O aplicativo ‘Control Center’ envia comandos para dispositivos Key Light aos quais está associado por HTTP. As solicitações de API definidas neste documento foram encontradas usando o Wireshark e a versão de referência 1.1.2 do aplicativo Elgato ‘Control Center’ (Windows 10).
Depois de serem adicionados a uma rede, os dispositivos Key Light provavelmente recebem endereços IP de um roteador via DHCP. Endereços IP específicos podem ser obtidos do servidor DHCP/roteador de rede, mas também são facilmente acessíveis no aplicativo ‘Centro de Controle’. Para fazer isso:
Accessory settings
(em forma de controle deslizante) ao lado do nome de um dispositivoAdvanced
. O endereço IP será apresentado em Comportamento de inicialização e Versão de firmwareOs dispositivos Key Light escutam comandos na porta 9123 .
Todas as solicitações devem ser enviadas para /elgato
.
Obtenha as configurações atuais de um dispositivo:
curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'
Os dispositivos Key Light não requerem autenticação.
Os dispositivos Key Light retornam apenas dois códigos de status HTTP:
200 OK
A solicitação foi bem-sucedida.400 Bad Request
A solicitação não foi compreendida pelo dispositivo (provavelmente devido à sintaxe malformada)Além disso, todos os dados retornados por um dispositivo serão formatados em JSON.
Existem apenas três recursos implementados pela API Key Light
lights
contêm informações relacionadas ao estado atual, brilho e temperatura de cor de um dispositivo Key Lightaccessory-info
Os objetos de informações sobre acessórios contêm informações relacionadas às especificações de hardware físico de um dispositivo Key Lightsettings
contêm informações relacionadas ao comportamento de um dispositivo Key Light Existe uma 'ação' implementada pela API Key Light:
identify
o envio de uma solicitação HTTP POST para este endpoint fará com que a luz fornecida pisque algumas vezes