OpenRGBClient class

Properties

deviceListUpdated Stream<void>
Stream to listen to be notified of devices connection and disconnections.
latefinal
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
serverVersion int
Server version
latefinal

Methods

disconnect() Future<void>
Disconnect from the server and close the socket.
getAllControllers() Future<List<RGBController>>
Get controller data of all controllers.
getControllerCount() Future<int>
Get the number of controllers connected to the server.
getControllerData(int deviceId) Future<RGBController>
Get controller data of one device with given deviceId.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setCustomMode(int deviceId) Future<void>
Sets custom mode for given deviceId. Custom mode is a mode that allows you to set the colors of the LEDs individually (Depending on device's capabilities).
setMode(int deviceId, int modeID, Color color) Future<void>
Sets a mode with given modeId on deviceId. color parameter does not always apply to all modes.
toString() String
A string representation of this object.
inherited
updateLeds(int deviceId, int numColors, Color color) Future<void>
Updates all LEDs with one color.
updateSingleLed(int deviceId, int ledID, Color color) Future<void>
Sets the color of the given LED for the given deviceId.

Operators

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

Static Methods

connect({String host = '127.0.0.1', int port = 6742, String? clientName}) Future<OpenRGBClient>
First function to call to connect to the server.