# LightState.Builder

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Ctors](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#pubctors)\|[Methods](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#inhmethods)  

# LightState.Builder

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/hardware/lights/LightState.Builder "View this page in Kotlin")\|Java

`
public
static
final

class
LightState.Builder
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|--------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.lights.LightState.Builder |

<br />

*** ** * ** ***

Builder for creating device light change requests.

## Summary

|                                                                                                          ### Public constructors                                                                                                          ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#Builder())`() ` Creates a new[LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder). |

|                                                                                                                                                                                                                   ### Public methods                                                                                                                                                                                                                    ||
|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[LightState](https://developer.android.com/reference/android/hardware/lights/LightState)                 | ` `[build](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#build())`() ` Create a LightState object used to control lights on the device.                                                                                                                                                               |
| ` `[LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder) | ` `[setColor](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#setColor(int))`(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](https://developer.android.com/reference/android/hardware/lights/LightState.Builder) | ` `[setPlayerId](https://developer.android.com/reference/android/hardware/lights/LightState.Builder#setPlayerId(int))`(int playerId) ` Set the desired player id of the LightState Builder, for a light with type[Light.LIGHT_TYPE_PLAYER_ID](https://developer.android.com/reference/android/hardware/lights/Light#LIGHT_TYPE_PLAYER_ID). |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Public constructors

### Builder

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Builder ()
```

Creates a new[LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder).

<br />

## Public methods

### build

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public LightState build ()
```

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

The generated[LightState](https://developer.android.com/reference/android/hardware/lights/LightState)should be used in[LightsRequest.Builder.addLight(Light, LightState)](https://developer.android.com/reference/android/hardware/lights/LightsRequest.Builder#addLight(android.hardware.lights.Light,%20android.hardware.lights.LightState)).

<br />

|                                                           Returns                                                            ||
|------------------------------------------------------------------------------------------|------------------------------------|
| [LightState](https://developer.android.com/reference/android/hardware/lights/LightState) | This value cannot be`null`. <br /> |

### setColor

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                               Parameters                               ||
|---------|---------------------------------------------------------------|
| `color` | `int`: the desired color and intensity in ARGB format. <br /> |

|                                                                                                                                                Returns                                                                                                                                                 ||
|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder) | The[LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder)object contains the light color and intensity. This value cannot be`null`. <br /> |

### setPlayerId

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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](https://developer.android.com/reference/android/hardware/lights/Light#LIGHT_TYPE_PLAYER_ID).

<br />

|                    Parameters                    ||
|------------|--------------------------------------|
| `playerId` | `int`: the desired player id. <br /> |

|                                                                                                                                        Returns                                                                                                                                         ||
|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder) | The[LightState.Builder](https://developer.android.com/reference/android/hardware/lights/LightState.Builder)object contains the player id. This value cannot be`null`. <br /> |