Summary: Ctors | Methods | Inherited Methods

MultiLightEffect.Builder

---

Kotlin |Java

public static final class MultiLightEffect.Builder
extends Object

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

---

Builder for MultiLightEffect objects.

Summary

Public constructors
Builder()

Public methods
MultiLightEffect.Builder	addLightSequence(Light light, ColorSequence colorSequence) Adds a new light and its corresponding sequence to the effect.
MultiLightEffect	build() Builds the light effect.
MultiLightEffect.Builder	setIterations(int iterations) Number of times that the effect should be played in a loop.
MultiLightEffect.Builder	setPreemptive(boolean preemptive) Sets whether this effect will preempt any previous effect / state currently active on the light.

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.

Public constructors

Builder

public Builder ()

Public methods

addLightSequence

public MultiLightEffect.Builder addLightSequence (Light light, 
                ColorSequence colorSequence)

Adds a new light and its corresponding sequence to the effect.

Parameters
light	Light: the light that will play the sequence. This value cannot be null.
colorSequence	ColorSequence: the sequence of colors and their timing. This value cannot be null.

Returns
MultiLightEffect.Builder	This value cannot be null.

Throws
IllegalArgumentException	if the light does not support animations.

build

public MultiLightEffect build ()

Builds the light effect.

Returns
MultiLightEffect	A MultiLightEffect with the configuration and sequences configured. This value cannot be null.

Throws
IllegalStateException	if no light-sequence pair has been provided.

setIterations

public MultiLightEffect.Builder setIterations (int iterations)

Number of times that the effect should be played in a loop.

By default, the builder configures this value to 1 for a single run of the effect.

A value of 0 indicates the effect should repeat indefinitely until a new effect or state is provided for the light or until the light is turned off.

If the effect has an initial state (delay = 0 for the first control point) the initial state will only be applied during the first iteration and all other iterations will ignore the initial value.

Parameters
iterations	int: number of times the effect should be played.

Returns
MultiLightEffect.Builder	This value cannot be null.

setPreemptive

public MultiLightEffect.Builder setPreemptive (boolean preemptive)

Sets whether this effect will preempt any previous effect / state currently active on the light.

By default, the builder sets this value to true and the effect is preemptive.

When preemptive=false AND the previous light state is a:

Permanent color: the playback will start immediately. Preemptive has no effect.

Non-infinite effect: the new effect will start after the previous effect ends all of its iterations.

Infinite effect: the playback will start after the current iteration of the effect finishes.

When preemptive=true the effect is applied immediately regardless of previous state.

Even when the effect preempts an existing state, the effect may not necessarily provide an initial state and the first control point may be relatively far in the future. Applications can make use of these conditions to create a fading effect between the last known state of the light and the new effect.

When creating fading effects, the following applies:

If the last known state is not an effect: last color becomes the starting color for the interpolator.

If the last known state is an effect: the last interpolated value becomes the starting color for the interpolator.

The system has a maximum of one non-preemptive event in the queue per light session. If an effect A is playing and the application requests two non-preemptive events (B and C) before A is done playing, only C will be kept and played after A, and B will be discarded.

Parameters
preemptive	boolean: true to play immediately or false wait for the previous effect to finish.

Returns
MultiLightEffect.Builder	This value cannot be null.