ElgatoKeylightAPI class

Wrapper around the Elgato Key Light API. To detect lights, please use the Bonjour protocol.

The API is divided in three parts:

  • Options (current configuration of the light: on/off, temperature…)
  • Accessory Info (details about a light: serial number…)
  • Settings (some settings of the light: power on brightness…)

Constructors

ElgatoKeylightAPI({required String ip, required int port})

Properties

hashCode → int
The hash code for this object.
no setterinherited
ip → String
IP address of the light.
final
port → int
Port of the light
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

formatUrl(String endpoint) → String
getLightAccessoryInfo() → Future<KeyLightInfo>
Returns information about a light (serial number…)
getLightOptions() → Future<KeyLightOptions>
Returns the current configuration of a light
getLightSettings() → Future<KeyLightSettings>
Returns some extra information about a light
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
updateLightOptions(KeyLightOptions newOptions) → Future<bool>
Update a light configuration. Note: wait a few milliseconds between each request, as the call may be ignored otherwise

Operators

operator ==(Object other) → bool
The equality operator.
inherited