androidx.wear.watchface
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.
Interfaces
CanvasComplication |
Interface for rendering complicationSlots onto a |
CanvasComplication.InvalidateCallback |
Interface for observing when a |
CanvasComplicationFactory |
Factory for creating a CanvasComplication. |
ComplicationSlotsManager.TapCallback |
Interface used to report user taps on the |
ComplicationTapFilter |
Interface for determining whether a tap hits a complication. |
Renderer.SharedAssets |
Multiple |
WatchFace.TapListener |
Listens for taps on the watchface. |
Classes
BackgroundComplicationTapFilter |
Default |
BoundingArc |
In combination with a bounding |
ComplicationSlot |
Represents the slot an individual complication on the screen may go in. |
ComplicationSlot.Builder |
Builder for constructing |
ComplicationSlotInflationFactory |
A ComplicationSlotInflationFactory provides the |
ComplicationSlotsManager |
The |
ContentDescriptionLabel |
Describes regions of the watch face for use by a screen reader. |
ListenableCanvasRenderer |
This class is deprecated. Use ListenableCanvasRenderer2 instead |
ListenableCanvasRenderer2 |
|
ListenableGlesRenderer |
This class is deprecated. Use ListenableGlesRenderer2 instead |
ListenableGlesRenderer2 |
|
ListenableStatefulWatchFaceRuntimeService |
|
ListenableStatefulWatchFaceService |
|
ListenableWatchFaceRuntimeService |
|
ListenableWatchFaceService |
|
RenderParameters |
Used to parameterize watch face rendering. |
RenderParameters.HighlightLayer |
The definition of what to include in the highlight layer. |
RenderParameters.HighlightedElement |
An element of the watch face to highlight. |
RenderParameters.HighlightedElement.ComplicationSlot |
A single |
RenderParameters.HighlightedElement.UserStyle |
A |
Renderer |
The base class for |
Renderer.CanvasRenderer |
This class is deprecated. CanvasRenderer is deprecated |
Renderer.CanvasRenderer2 |
Watch faces that require |
Renderer.GlesRenderer |
This class is deprecated. GlesRenderer is deprecated |
Renderer.GlesRenderer2 |
Watch faces that require |
RoundRectComplicationTapFilter |
Default |
StatefulWatchFaceRuntimeService |
|
StatefulWatchFaceService |
|
TapEvent |
An input event received by the watch face. |
WatchFace |
The return value of |
WatchFace.LegacyWatchFaceOverlayStyle |
Legacy Wear 2.0 watch face styling. |
WatchFace.OverlayStyle |
This class is deprecated. OverlayStyle will be removed in a future release. |
WatchFaceColors |
Provides information about the colors of a watch face, exposing the three most representative colors. |
WatchFaceRuntimeService |
WatchFaceRuntimeService is a special kind of |
WatchFaceService |
WatchFaceService and |
WatchState |
Describes the current state of the wearable including some hardware details such as whether or not it supports burn in prevention and low-bit ambient. |
Exceptions
Renderer.GlesRenderer.GlesException |
Exception thrown if a GL call fails |
Objects
CanvasType |
Describes the type of |
ComplicationSlotBoundsType |
The various types of |
RenderParameters.HighlightedElement.AllComplicationSlots |
All |
TapType |
The types of tap events the system can forward to the watch face. |
WatchFaceType |
The type of watch face, whether it's digital or analog. |