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.

class MonochromaticImage

A simple, monochromatic image that can be tinted by the watch face.

A monochromatic image doesn't have to be black and white, it can have a single color associated with the provider / brand with the expectation that the watch face may recolor it (typically using a SRC_IN filter).

An ambient alternative is provided that may be shown instead of the regular image while the watch is not active.

Summary

Nested types

Builder for MonochromaticImage.

Public companion properties
MonochromaticImage

For use when the real data isn't available yet, this MonochromaticImage should be rendered as a placeholder.

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Icon?

The image to be shown when the device is in ambient mode to save power or avoid burn in
Icon

The image itself

Public companion properties

PLACEHOLDER

val PLACEHOLDER: MonochromaticImage

For use when the real data isn't available yet, this MonochromaticImage should be rendered as a placeholder. It is suggested that it should be rendered with a light grey box.

Note a placeholder may only be used in the context of NoDataComplicationData.placeholder.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

ambientImage

Added in 1.0.0
val ambientImage: Icon?

The image to be shown when the device is in ambient mode to save power or avoid burn in

image

Added in 1.0.0
val image: Icon

The image itself