LightState.Builder

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.

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder ()

Creates a new LightState.Builder.

Public methods

build

Added in API level 31
public LightState build ()

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

The generated LightState should be used in LightsRequest.Builder#addLight(Light, LightState).

Returns
LightState This value cannot be null.

setColor

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.

setPlayerId

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.