RemoteWatchFaceViewHost


public interface RemoteWatchFaceViewHost extends AutoCloseable


Intended for use by watch face editors, a RemoteWatchFaceViewHost allows the watch face to send a SurfaceControlViewHost.SurfacePackage to the client, which the client can attach to a SurfaceView with SurfaceView.setChildSurfacePackage. The client can request an updated screen shot by calling renderWatchFace.

use Watch Face Format instead

Summary

Public methods

abstract @NonNull SurfaceControlViewHost.SurfacePackage

This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

abstract void
renderWatchFace(
    @NonNull RenderParameters renderParameters,
    @NonNull Instant instant,
    UserStyle userStyle,
    Map<@NonNull Integer, @NonNull ComplicationData> idAndComplicationData
)

This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Inherited methods

From java.lang.AutoCloseable
abstract void

This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public methods

getSurfacePackage

Added in 1.2.0
Deprecated in 1.3.0-alpha06
abstract @NonNull SurfaceControlViewHost.SurfacePackage getSurfacePackage()

The SurfaceControlViewHost.SurfacePackage the client should attach to a SurfaceView via SurfaceView.setChildSurfacePackage. The watch face will render into this view when renderWatchFace is called.

renderWatchFace

abstract void renderWatchFace(
    @NonNull RenderParameters renderParameters,
    @NonNull Instant instant,
    UserStyle userStyle,
    Map<@NonNull Integer, @NonNull ComplicationData> idAndComplicationData
)

Renders the watchface into the view associated with surfacePackage.

Parameters
@NonNull RenderParameters renderParameters

The RenderParameters to draw with.

@NonNull Instant instant

The Instant render with.

UserStyle userStyle

Optional UserStyle to render with, if null the current style is used.

Map<@NonNull Integer, @NonNull ComplicationData> idAndComplicationData

Map of complication ids to ComplicationData to render with, or if null then the existing complication data if any is used.