หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

API ของ Elgato Key Light

การแนะนำ

Elgato Key Light และ Key Light Air เป็นไฟวิดีโอ LED แบบมีขอบซึ่งได้รับความนิยมจากสตรีมเมอร์สดบนแพลตฟอร์มเช่น Twitch ไฟเหล่านี้เป็นอุปกรณ์ IoT และโดยปกติจะควบคุมด้วยแอป 'ศูนย์ควบคุม' ของ Elgato หรือผ่านหนึ่งในอุปกรณ์ Stream Deck (ผลิตโดย Elgato เช่นกัน) อุปกรณ์ Key Light ไม่รองรับการผสานรวมของบุคคลที่สามโดยกำเนิด แต่สามารถควบคุมได้โดยการเชื่อมต่อกับ API ในตัวของไฟโดยตรง

การค้นพบ API

แอป "ศูนย์ควบคุม" จะส่งคำสั่งไปยังอุปกรณ์ Key Light ที่เชื่อมโยงผ่าน HTTP พบคำขอ API ที่กำหนดไว้ในเอกสารนี้โดยใช้ Wireshark และเวอร์ชันอ้างอิง 1.1.2 ของแอป Elgato 'Control Center' (Windows 10)

จุดสิ้นสุด

ที่อยู่ IP ของอุปกรณ์

หลังจากเพิ่มเข้ากับเครือข่ายแล้ว อุปกรณ์ Key Light น่าจะได้รับที่อยู่ IP จากเราเตอร์ผ่าน DHCP คุณสามารถดึงที่อยู่ IP เฉพาะจากเซิร์ฟเวอร์ DHCP / เราเตอร์เครือข่ายได้ แต่ก็สามารถเข้าถึงได้ง่ายในแอป 'ศูนย์ควบคุม' เมื่อต้องการทำสิ่งนี้:

  1. เปิด / เปิดแอป 'ศูนย์ควบคุม'
  2. คลิกที่ไอคอน Accessory settings (รูปร่างเหมือนแถบเลื่อน) ถัดจากชื่ออุปกรณ์
  3. ขยายส่วน Advanced ที่อยู่ IP จะถูกนำเสนอภายใต้ พฤติกรรมการเปิดเครื่อง และ เวอร์ชันเฟิร์มแวร์

พอร์ตอุปกรณ์

อุปกรณ์ Key Light จะคอยฟังคำสั่งบนพอร์ต 9123

URL พื้นฐาน

คำขอทั้งหมดควรถูกส่งไปยัง /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

ทรัพยากร

มีทรัพยากรเพียง 3 รายการเท่านั้นที่นำไปใช้โดย Key Light API

  • ไฟ วัตถุ lights มีข้อมูลที่เกี่ยวข้องกับสถานะปัจจุบัน ความสว่าง และอุณหภูมิสีของอุปกรณ์ Key Light
  • accessory-info ออบเจ็กต์อุปกรณ์เสริม-ข้อมูลมีข้อมูลที่เกี่ยวข้องกับข้อกำหนดฮาร์ดแวร์ทางกายภาพของอุปกรณ์ Key Light
  • settings ต์การตั้งค่ามีข้อมูลที่เกี่ยวข้องกับการทำงานของอุปกรณ์ Key Light

ฟังก์ชั่น

มี 'การกระทำ' อย่างหนึ่งที่ Key Light API นำมาใช้:

  • identify การส่งคำขอ HTTP POST ไปยังจุดสิ้นสุดนี้จะทำให้ไฟที่กำหนดกะพริบสองสามครั้ง
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด