androidx.wear.watchface.editor


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

EditorSession

Interface for manipulating watch face state during a watch face editing session.

Classes

ChosenComplicationDataSource

The complication data source that was chosen by the user for a given androidx.wear.watchface.ComplicationSlot id as a result to a call to EditorSession.openComplicationDataSourceChooser.

EditorRequest

The request sent by WatchFaceEditorContract.createIntent.

ListenableEditorSession

ListenableFuture-based compatibility wrapper around EditorSession's suspending methods.

PreviewScreenshotParams

Parameters for an optional final screenshot taken by EditorSession upon exit and reported via EditorState.

WatchFaceEditorContract

An ActivityResultContract for invoking a watch face editor.