LightState.Builder

Kotlin |Java

public static final class LightState.Builder
extends Object

java.lang.Object
↳	android.hardware.lights.LightState.Builder

Builder for creating device light change requests.

Summary

Public constructors
`Builder()` Creates a new `LightState.Builder`.

Public methods
`LightState`	`build()` Create a LightState object used to control lights on the device.
`LightState.Builder`	`setColor(int color)` Set the desired color and intensity of the LightState Builder, for a light type of RBG color or single monochrome color.
`LightState.Builder`	`setPlayerId(int playerId)` Set the desired player id of the LightState Builder, for a light with type `Light.LIGHT_TYPE_PLAYER_ID`.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Added in API level 31

public Builder ()

Added in API level 31

public LightState build ()

Create a LightState object used to control lights on the device.

Returns
`LightState`	This value cannot be `null`.

Added in API level 31

public LightState.Builder setColor (int color)

Set the desired color and intensity of the LightState Builder, for a light type of RBG color or single monochrome color.

Parameters
`color`	`int`: the desired color and intensity in ARGB format.

Returns
`LightState.Builder`	The `LightState.Builder` object contains the light color and intensity. This value cannot be `null`.

Added in API level 31

public LightState.Builder setPlayerId (int playerId)

Set the desired player id of the LightState Builder, for a light with type Light.LIGHT_TYPE_PLAYER_ID.

Parameters
`playerId`	`int`: the desired player id.

Returns
`LightState.Builder`	The `LightState.Builder` object contains the player id. This value cannot be `null`.