Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

MultiLightEffect

---

Kotlin |Java

public final class MultiLightEffect
extends Object implements Parcelable

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

---

Models an effect that will be shown in one or more lights.

Effects are comprised of [light, ColorSequence] pairs defining how each light should change over time along with some extra configuration values:

• Iterations: the number of times the effect will be played back to back.
• Preemptive: whether this effect should preempt any previously playing state or if it should be played after the current effect finishes.

A MultiLightEffect is treated as a unit with a given start time and an implicit duration:

• Start time: all lights sequences in the effect start at the same time, regardless of having a initial state or not.
• Duration: the duration of the effect is the duration of the longest sequence it contains. If a light sequence in the effect is shorter than the effect duration, the light will remain as a solid color until the end of the effect.

ColorSequences in the effect could have initial states (delay=0) for their corresponding lights, which has special implications when the effect will be played as a continuation of another effect (effects with preemptive=false and/or effects with initial states and more than one iteration).

The initial state will be applied only if the effect is set to preemptive and it is the first iteration of the effect. The system ignores the initial state in subsequent iterations or in effects with preemptive=false to allow the light to transition smoothly and avoid flicks.

Summary

Nested classes
class	MultiLightEffect.Builder Builder for MultiLightEffect objects.

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<MultiLightEffect>	CREATOR Implement the Parcelable interface

Public methods
int	describeContents() Implement the Parcelable interface
int	getIterations() Returns the number of times this effect will be played in a loop.
Map<Integer, ColorSequence>	getSequences() Returns the color sequences defined in the light effect for each of the lights.
boolean	isPreemptive() Returns whether this effect will cancel any previously playing effect.
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.

Fields

CREATOR

public static final Creator<MultiLightEffect> CREATOR

Implement the Parcelable interface

Public methods

describeContents

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

getIterations

public int getIterations ()

Returns the number of times this effect will be played in a loop. Defaults to 1.

Returns
int	the number of iterations to play.

getSequences

public Map<Integer, ColorSequence> getSequences ()

Returns the color sequences defined in the light effect for each of the lights.

The key for the returned map corresponds to the lightId (see Light.getId()) of the light that will play the color sequence represented by the value.

Returns
Map<Integer, ColorSequence>	the Map of lightIds to the color sequences that will be played for the effect. This value cannot be null.

isPreemptive

public boolean isPreemptive ()

Returns whether this effect will cancel any previously playing effect.

Returns
boolean	true if this effect applies immediately, false otherwise.

toString

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

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 the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE