Note: As of July 10, 2024, watch faces must use the Watch Face Format in order to be installed on new watches that launch with Wear OS 5 pre-installed. Learn more about the user-facing changes in this Help Center article.

Additionally, starting in early 2025 (specific date to be announced during Q4 2024), all new watch faces published on Google Play must use the Watch Face Format.

public final class SmallImage.Builder

Builder for SmallImage.

Summary

Public constructors

Public methods
final @NonNull SmallImage

Builds a SmallImage.
final @NonNull SmallImage.Builder
setAmbientImage(Icon ambientImage)

Sets a different image for when the device is ambient mode to save power and prevent burn in.

Public constructors

Builder

Added in 1.0.0
public Builder(@NonNull Icon image, @NonNull SmallImageType type)
Parameters
@NonNull Icon image

The Icon representing the image
@NonNull SmallImageType type

The style of the image provided, to guide how it should be displayed

Public methods

build

Added in 1.0.0
public final @NonNull SmallImage build()

Builds a SmallImage.

setAmbientImage

Added in 1.0.0
public final @NonNull SmallImage.Builder setAmbientImage(Icon ambientImage)

Sets a different image for when the device is ambient mode to save power and prevent burn in. If no ambient variant is provided, the watch face may not show anything while in ambient mode.