Added in API level 31

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

Light

---

Kotlin |Java

public final class Light
extends Object implements Parcelable

java.lang.Object
↳	android.hardware.lights.Light

---

Represents a logical light on the device.

Summary

Constants
int	LIGHT_CAPABILITY_BRIGHTNESS Capability for lights that could adjust its LED brightness.
int	LIGHT_CAPABILITY_COLOR_RGB Capability for lights that have red, green and blue LEDs to control the light's color.
int	LIGHT_CAPABILITY_RGB This constant was deprecated in API level 34. Wrong int based flag with value 0. Use capability flag LIGHT_CAPABILITY_COLOR_RGB instead.
int	LIGHT_TYPE_INPUT Type for lights that indicate a monochrome color LED light.
int	LIGHT_TYPE_KEYBOARD_BACKLIGHT Type for lights that illuminate keyboard keys.
int	LIGHT_TYPE_MICROPHONE Type for lights that indicate microphone usage
int	LIGHT_TYPE_PLAYER_ID Type for lights that indicate a group of LED lights representing player id.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<Light>	CREATOR Implement the Parcelable interface

Public methods
int	describeContents() Implement the Parcelable interface
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
int	getId() Returns the id of the light.
String	getName() Returns the name of the light.
int	getOrdinal() Returns the ordinal of the light.
int	getType() Returns the logical type of the light.
boolean	hasBrightnessControl() Check whether the light has led brightness control.
boolean	hasRgbControl() Check whether the light has RGB led control.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Implement the Parcelable interface

Inherited methods
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.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

LIGHT_CAPABILITY_BRIGHTNESS

Added in API level 31

public static final int LIGHT_CAPABILITY_BRIGHTNESS

Capability for lights that could adjust its LED brightness. If the capability is not present the LED can only be turned either on or off.

Constant Value: 1 (0x00000001)

LIGHT_CAPABILITY_COLOR_RGB

Added in API level 34

public static final int LIGHT_CAPABILITY_COLOR_RGB

Capability for lights that have red, green and blue LEDs to control the light's color.

Constant Value: 2 (0x00000002)

LIGHT_CAPABILITY_RGB

Added in API level 31
Deprecated in API level 34

public static final int LIGHT_CAPABILITY_RGB

This constant was deprecated in API level 34.
Wrong int based flag with value 0. Use capability flag LIGHT_CAPABILITY_COLOR_RGB instead.

Capability for lights that have red, green and blue LEDs to control the light's color.

Constant Value: 0 (0x00000000)

LIGHT_TYPE_INPUT

Added in API level 31

public static final int LIGHT_TYPE_INPUT

Type for lights that indicate a monochrome color LED light.

Constant Value: 10001 (0x00002711)

LIGHT_TYPE_KEYBOARD_BACKLIGHT

Added in API level 34

public static final int LIGHT_TYPE_KEYBOARD_BACKLIGHT

Type for lights that illuminate keyboard keys.

Constant Value: 10003 (0x00002713)

LIGHT_TYPE_MICROPHONE

Added in API level 31

public static final int LIGHT_TYPE_MICROPHONE

Type for lights that indicate microphone usage

Constant Value: 8 (0x00000008)

LIGHT_TYPE_PLAYER_ID

Added in API level 31

public static final int LIGHT_TYPE_PLAYER_ID

Type for lights that indicate a group of LED lights representing player id. Player id lights normally present on game controllers are lights that consist of a row of LEDs. During multi-player game, the player id for the current game controller is represented by one of the LED that is lit according to its position in the row.

Constant Value: 10002 (0x00002712)

Fields

CREATOR

Added in API level 31

public static final Creator<Light> CREATOR

Implement the Parcelable interface

Public methods

describeContents

Added in API level 31

public int describeContents ()

Implement the Parcelable interface

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getId

Added in API level 31

public int getId ()

Returns the id of the light.

This is an opaque value used as a unique identifier for the light.

Returns
int

getName

Added in API level 31

public String getName ()

Returns the name of the light.

Returns
String	This value cannot be null.

getOrdinal

Added in API level 31

public int getOrdinal ()

Returns the ordinal of the light.

This is a sort key that represents the physical order of lights on the device with the same type. In the case of multiple lights arranged in a line, for example, the ordinals could be [1, 2, 3, 4], or [0, 10, 20, 30], or any other values that have the same sort order.

Returns
int

getType

Added in API level 31

public int getType ()

Returns the logical type of the light.

Returns
int	Value is LIGHT_TYPE_MICROPHONE, LIGHT_TYPE_INPUT, LIGHT_TYPE_PLAYER_ID, LIGHT_TYPE_KEYBOARD_BACKLIGHT, android.hardware.lights.Light.LIGHT_TYPE_KEYBOARD_MIC_MUTE, or android.hardware.lights.Light.LIGHT_TYPE_KEYBOARD_VOLUME_MUTE

hasBrightnessControl

Added in API level 31

public boolean hasBrightnessControl ()

Check whether the light has led brightness control.

Returns
boolean	True if the hardware can control the led brightness, otherwise false.

hasRgbControl

Added in API level 31

public boolean hasRgbControl ()

Check whether the light has RGB led control.

Returns
boolean	True if the hardware can control the RGB led, otherwise false.

hashCode

Added in API level 31

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 31

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 31

public void writeToParcel (Parcel dest, 
                int flags)

Implement the Parcelable interface

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES