Added in API level 27

WallpaperColors

class WallpaperColors : Parcelable
kotlin.Any
   ↳ android.app.WallpaperColors

Provides information about the colors of a wallpaper.

Exposes the 3 most visually representative colors of a wallpaper. Can be either WallpaperColors#getPrimaryColor(), WallpaperColors#getSecondaryColor() or WallpaperColors#getTertiaryColor().

Summary

Constants
static Int

Specifies that dark text is preferred over the current wallpaper for best presentation.
static Int

Specifies that dark theme is preferred over the current wallpaper for best presentation.
Inherited constants
Public constructors

WallpaperColors(primaryColor: Color, secondaryColor: Color?, tertiaryColor: Color?)

Constructs a new object from three colors.
WallpaperColors(primaryColor: Color, secondaryColor: Color?, tertiaryColor: Color?, colorHints: Int)

Constructs a new object from three colors, where hints can be specified.
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
static WallpaperColors!
fromBitmap(bitmap: Bitmap)

Constructs WallpaperColors from a bitmap.
static WallpaperColors!
fromDrawable(drawable: Drawable!)

Constructs WallpaperColors from a drawable.
Int

Returns the color hints for this instance.
Color

Gets the most visually representative color of the wallpaper.
Color?

Gets the second most preeminent color of the wallpaper.
Color?

Gets the third most preeminent color of the wallpaper.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)
Properties
static Parcelable.Creator<WallpaperColors!>

Constants

HINT_SUPPORTS_DARK_TEXT

Added in API level 31
static val HINT_SUPPORTS_DARK_TEXT: Int

Specifies that dark text is preferred over the current wallpaper for best presentation.

eg. A launcher may set its text color to black if this flag is specified.

Value: 1

HINT_SUPPORTS_DARK_THEME

Added in API level 31
static val HINT_SUPPORTS_DARK_THEME: Int

Specifies that dark theme is preferred over the current wallpaper for best presentation.

eg. A launcher may set its drawer color to black if this flag is specified.

Value: 2

Public constructors

WallpaperColors

Added in API level 27
WallpaperColors(parcel: Parcel!)

WallpaperColors

Added in API level 27
WallpaperColors(
    primaryColor: Color, 
    secondaryColor: Color?, 
    tertiaryColor: Color?)

Constructs a new object from three colors.

Parameters
primaryColor Color: Primary color. This value cannot be null.
secondaryColor Color?: Secondary color. This value may be null.
tertiaryColor Color?: Tertiary color. This value may be null.

WallpaperColors

Added in API level 31
WallpaperColors(
    primaryColor: Color, 
    secondaryColor: Color?, 
    tertiaryColor: Color?, 
    colorHints: Int)

Constructs a new object from three colors, where hints can be specified.

Parameters
primaryColor Color: Primary color. This value cannot be null.
secondaryColor Color?: Secondary color. This value may be null.
tertiaryColor Color?: Tertiary color. This value may be null.
colorHints Int: A combination of color hints. Value is either 0 or a combination of android.app.WallpaperColors#HINT_SUPPORTS_DARK_TEXT, and android.app.WallpaperColors#HINT_SUPPORTS_DARK_THEME

Public methods

describeContents

Added in API level 27
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 27
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.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

fromBitmap

Added in API level 27
static fun fromBitmap(bitmap: Bitmap): WallpaperColors!

Constructs WallpaperColors from a bitmap.

Main colors will be extracted from the bitmap.

Parameters
bitmap Bitmap: Source where to extract from. This value cannot be null.

fromDrawable

Added in API level 27
static fun fromDrawable(drawable: Drawable!): WallpaperColors!

Constructs WallpaperColors from a drawable.

Main colors will be extracted from the drawable.

Parameters
drawable Drawable!: Source where to extract from.

getColorHints

Added in API level 31
fun getColorHints(): Int

Returns the color hints for this instance.

Return
Int The color hints. Value is either 0 or a combination of android.app.WallpaperColors#HINT_SUPPORTS_DARK_TEXT, and android.app.WallpaperColors#HINT_SUPPORTS_DARK_THEME

getPrimaryColor

Added in API level 27
fun getPrimaryColor(): Color

Gets the most visually representative color of the wallpaper. "Visually representative" means easily noticeable in the image, probably happening at high frequency. fromBitmap

Return
Color A color. This value cannot be null.

getSecondaryColor

Added in API level 27
fun getSecondaryColor(): Color?

Gets the second most preeminent color of the wallpaper. Can be null.

Return
Color? A color, may be null.

getTertiaryColor

Added in API level 27
fun getTertiaryColor(): Color?

Gets the third most preeminent color of the wallpaper. Can be null.

Return
Color? A color, may be null.

hashCode

Added in API level 27
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 27
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 27
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 27
static val CREATOR: Parcelable.Creator<WallpaperColors!>