EditorSession

@RequiresApi(value = 27)
@UiThread
fun createHeadlessEditorSession(
    activity: ComponentActivity,
    editIntent: Intent,
    headlessWatchFaceClient: HeadlessWatchFaceClient
): EditorSession

Constructs an EditorSession for a remote watch face editor.

Caution the remote watchface must have been built with the same version of the watch face libraries.

@UiThread
suspend fun createOnWatchEditorSession(activity: ComponentActivity): EditorSession

Constructs an EditorSession for an on watch face editor. This registers an activity result handler and so it must be called during an Activity or Fragment initialization path. The EditorSession is lifecycle aware and will automatically close when onDestroy is received.

val DEFAULT_PREVIEW_INSTANT: Instant

If passed renderWatchFaceToBitmap this will signal that the watch face's default preview time should be used.

val EDITING_SESSION_TIMEOUT: Duration

Timeout allowed for waiting for creating the watch face editing session.

@UiThread
fun getComplicationSlotIdAt(x: @Px Int, y: @Px Int): Int?

Returns the ID of the complication at the given coordinates or null if there isn't one. Only androidx.wear.watchface.ComplicationSlots with ComplicationSlotBoundsType.ROUND_RECT are supported by this function.

@UiThread
suspend fun openComplicationDataSourceChooser(complicationSlotId: Int): ChosenComplicationDataSource?

Opens the complication data source chooser and returns the chosen complication data source for the specified androidx.wear.watchface.ComplicationSlot.

The result returns null if the operation was cancelled and otherwise returned an instance of ChosenComplicationDataSource that contains information about the chosen data source.

@UiThread
fun renderWatchFaceToBitmap(
    renderParameters: RenderParameters,
    instant: Instant,
    slotIdToComplicationData: Map<Int, ComplicationData>?
): Bitmap

Renders the watch face to a Bitmap using the current userStyle.

open fun setOverrideComplications(
    slotIdToComplicationData: Map<Int, ComplicationData>
): Unit

For the duration of the editor session, applies an override to complications rendered via renderWatchFaceToBitmap. If you need to render multiple times with the same slotIdToComplicationData it's more efficient to use this API and call renderWatchFaceToBitmap with null slotIdToComplicationData. When the editor session ends this override will be removed.

Note if after this call updated complications are sent via InteractiveWatchFaceClient.updateComplicationData, they will only be applied once the editor session has ended.

val backgroundComplicationSlotId: Int?

The ID of the background complication or null if there isn't one.

var commitChangesOnClose: Boolean

Whether any changes should be committed when the session is closed (defaults to true).

Note due to SysUI requirements EditorState can't reliably be sent in the activity result because there are circumstances where ComponentActivity.onStop doesn't get called but the UX requires us to commit changes.

Regardless of the value, on completion of the editor session, the original UserStyle is restored. Note we need SysUI's help to revert any complication data source changes. Caveat some complication data sources have their own config (e.g. the world clock has a timezone setting) and that config currently can't be reverted.

val complicationSlotsState: StateFlow<Map<Int, ComplicationSlotState>>

A Flow of a Map of complication slot ids to ComplicationSlotState for each complication slot.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

val complicationsDataSourceInfo: StateFlow<Map<Int, ComplicationDataSourceInfo?>>

Returns a flow of maps of androidx.wear.watchface.ComplicationSlot ids to ComplicationDataSourceInfo that represent the information available about the data source for each complication. This data is fetched asynchronously and the map will initially be empty. For watch faces without complications this will always be empty.

Note new data may be pushed as result of running openComplicationDataSourceChooser.

Note a null ComplicationDataSourceInfo will be associated with a complication slot id if the androidx.wear.watchface.ComplicationSlot is configured to show the empty complication data source.

val complicationsPreviewData: StateFlow<Map<Int, ComplicationData>>

Returns a flow of maps of androidx.wear.watchface.ComplicationSlot ids to preview ComplicationData suitable for use in rendering a preview of the watch face. This data is fetched asynchronously and the map will initially be empty. For watch faces without complications this will always be empty.

Note new data may be pushed as a result of running openComplicationDataSourceChooser.

Note if a slot is configured to be empty then the map will contain an instance of EmptyComplicationData for that slot. Disabled complicationSlots are included in the map.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

val previewReferenceInstant: Instant

The reference preview Instant for this watch face to render previews with.

val userStyle: MutableStateFlow<UserStyle>

The current UserStyle. Assigning to this will cause the style to update. However, styling changes to the watch face will be reverted upon exit.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

val userStyleSchema: UserStyleSchema

The watch face's UserStyleSchema.

val watchFaceComponentName: ComponentName

The ComponentName of the watch face being edited.

val watchFaceId: WatchFaceId

Unique ID for the instance of the watch face being edited. Note each distinct ComponentName can sometimes have multiple instances. See WatchFaceId for more details.