ColorSequence

Kotlin |Java

public final class ColorSequence
extends Object implements Parcelable

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

Models a sequence of colors and their relative timing to create a light effect.

The control points in this object represent specific points in time when the light will be set to the specified color. Control points can be arbitrarily distant in time and the light will be interpolated each frame to smoothly transition between control points.

Control points have three main components:

color: the target color for the light.
delay: how long the light takes to transition from color[n-1] to color[n], expressed in milliseconds relative to the last control point (or permanent state if the light is not playing an effect).
interpolation mode: the interpolation algorithm to use to transition between colors. It is important to note that the interpolation is done per color channel on every frame (see Light.getMinUpdatePeriodMillis()).

Summary

Nested classes
`class`	`ColorSequence.Builder` Builder for `ColorSequence` objects.

Constants
`int`	`INTERPOLATION_MODE_LINEAR` Linear interpolation between control points.
`int`	`INTERPOLATION_MODE_NONE` No interpolation between control points.

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<ColorSequence>`	`CREATOR` Implements the Parcelable interface

Public methods
`int`	`describeContents()` Implements the Parcelable interface
`int[]`	`getColors()` Returns the sequence of colors defined in this light effect.
`long[]`	`getDelaysMillis()` Returns the sequence of delays configured for the effect.
`long`	`getDurationMillis()` Calculates the estimated duration of a single iteration of the light effect.
`int`	`getInterpolationMode()` Returns the type of interpolation that will be used to ramp the color to the final value.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Implements 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

INTERPOLATION_MODE_LINEAR

public static final int INTERPOLATION_MODE_LINEAR

Linear interpolation between control points.

With this interpolation mode, the transition from color[n-1] to color[n] happens linearly over delayMillis[n] milliseconds, with color updates every frame.

Each color channel is interpolated independently.

Constant Value: 1 (0x00000001)

INTERPOLATION_MODE_NONE

public static final int INTERPOLATION_MODE_NONE

No interpolation between control points.

With this interpolation mode, color[n-1] will be held for the corresponding duration specified in delayMillis. After that, color[n] will be applied without any intermediate steps.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<ColorSequence> CREATOR

Implements the Parcelable interface

Public methods

describeContents

public int describeContents ()

Implements 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`

getColors

public int[] getColors ()

Returns the sequence of colors defined in this light effect.

Returns
`int[]`	Array of colors that will be played for this effect. This value cannot be `null`.

getDelaysMillis

public long[] getDelaysMillis ()

Returns the sequence of delays configured for the effect.
Value is a non-negative duration in milliseconds.

Returns
`long[]`	Array of delays configured for this effect. This value cannot be `null`. Value is a non-negative duration in milliseconds.

getDurationMillis

public long getDurationMillis ()

Calculates the estimated duration of a single iteration of the light effect.
Value is a non-negative duration in milliseconds.

Returns
`long`	the estimated duration of one iteration of this light effect in number of frames. Value is a non-negative duration in milliseconds.

getInterpolationMode

public int getInterpolationMode ()

Returns the type of interpolation that will be used to ramp the color to the final value.

Returns
`int`	Interpolation mode to be used in the animation. Value is one of the following: `INTERPOLATION_MODE_NONE` `INTERPOLATION_MODE_LINEAR`

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)

Implements 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`

ColorSequence

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

INTERPOLATION_MODE_LINEAR

INTERPOLATION_MODE_NONE

Fields

CREATOR

Public methods

describeContents

getColors

getDelaysMillis

getDurationMillis

getInterpolationMode

toString

writeToParcel