SmallImage.Builder

Artifact: androidx.wear.watchface:watchface-complications-data

View Source

Added in 1.0.0

---

Kotlin |Java

class SmallImage.Builder

---

Builder for SmallImage.

Summary

Public constructors
Builder(image: Icon, type: SmallImageType)

Public functions
SmallImage	build() Builds a SmallImage.
SmallImage.Builder	setAmbientImage(ambientImage: Icon?) 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

Builder(image: Icon, type: SmallImageType)

Parameters
image: Icon	The Icon representing the image
type: SmallImageType	The style of the image provided, to guide how it should be displayed

Public functions

build

Added in 1.0.0

fun build(): SmallImage

Builds a SmallImage.

setAmbientImage

Added in 1.0.0

fun setAmbientImage(ambientImage: Icon?): SmallImage.Builder

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.