Light

LIGHT_CAPABILITY_BRIGHTNESS

static val LIGHT_CAPABILITY_BRIGHTNESS: Int

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.

Value: 1

LIGHT_CAPABILITY_COLOR_RGB

static val LIGHT_CAPABILITY_COLOR_RGB: Int

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

Value: 2

LIGHT_CAPABILITY_RGB

static val LIGHT_CAPABILITY_RGB: Int

Deprecated: 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.

Value: 0

LIGHT_TYPE_INPUT

static val LIGHT_TYPE_INPUT: Int

Type for lights that indicate a monochrome color LED light.

Value: 10001

LIGHT_TYPE_KEYBOARD_BACKLIGHT

static val LIGHT_TYPE_KEYBOARD_BACKLIGHT: Int

Type for lights that illuminate keyboard keys.

Value: 10003

LIGHT_TYPE_MICROPHONE

static val LIGHT_TYPE_MICROPHONE: Int

Type for lights that indicate microphone usage

Value: 8

LIGHT_TYPE_PLAYER_ID

static val LIGHT_TYPE_PLAYER_ID: Int

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.

Value: 10002

describeContents

fun describeContents(): Int

Implement the Parcelable interface

equals

fun equals(other: Any?): Boolean

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.

getId

fun getId(): Int

Returns the id of the light.

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

getName

fun getName(): String

Returns the name of the light.

getOrdinal

fun getOrdinal(): Int

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.

getType

fun getType(): Int

Returns the logical type of the light.

hasBrightnessControl

fun hasBrightnessControl(): Boolean

Check whether the light has led brightness control.

hasRgbControl

fun hasRgbControl(): Boolean

Check whether the light has RGB led control.

hashCode

fun hashCode(): Int

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Implement the Parcelable interface

CREATOR

static val CREATOR: Parcelable.Creator<Light!>

Implement the Parcelable interface