程序包 ohos.miscservices.wallpaper

类 WallpaperColorsCollection

java.lang.Object

ohos.miscservices.wallpaper.WallpaperColorsCollection

public class WallpaperColorsCollection
extends Object

Provides dominant colors of the wallpaper.

The colors are obtained in descending order of their dominance. You can use WallpaperColorsCollection#count() to obtain the number of the dominant colors.

从以下版本开始:

3

SystemCapability

SystemCapability.Miscservices#WALLPAPER

方法概要

限定符和类型	方法	说明
int	count()	Obtains the number of dominant colors.
RgbColor	getNthRepresentativeColor(int nth)	Obtains the dominant color at the specified index.
boolean	hasNext()	Checks whether there are other dominant colors.
RgbColor	next()	Obtains the next dominant color of the wallpaper.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

next

public RgbColor next()

Obtains the next dominant color of the wallpaper.

返回:

Returns the dominant color.

从以下版本开始:

3

count

public int count()

Obtains the number of dominant colors.

返回:

Returns the number of dominant colors.

从以下版本开始:

3

hasNext

public boolean hasNext()

Checks whether there are other dominant colors.

返回:

Returns true if there are other dominant colors; returns false otherwise.

从以下版本开始:

3

getNthRepresentativeColor

public RgbColor getNthRepresentativeColor(int nth)

Obtains the dominant color at the specified index. If you set nth to 0, the primary dominant color will be returned.

参数:

nth - Indicates the index of the dominant color to obtain. The value is an integer starting from 0.

返回:

Returns the dominant color if obtained; returns null if nth >= WallpaperColorsCollection#count().

从以下版本开始:

3