HeadlessWatchFaceClient
interface HeadlessWatchFaceClient : AutoCloseable
Controls a stateless remote headless watch face. This is mostly intended for use by watch face editor UIs which need to generate screenshots for various styling configurations without affecting the current watchface.
Note clients should call close when finished.
use Watch Face Format instead
Summary
Nested types |
|---|
|
This interface is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public companion functions |
|
|---|---|
HeadlessWatchFaceClient |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public functions |
|
|---|---|
Unit |
@AnyThreadThis function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
open UserStyleFlavors |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
open ByteArray |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Boolean |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Unit |
@AnyThreadThis function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Bitmap? |
@RequiresApi(value = 27)This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Bitmap |
@RequiresApi(value = 27)This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Bundle |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public properties |
|
|---|---|
Map<Int, ComplicationSlotState> |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
open Boolean |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Instant |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
UserStyleSchema |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Inherited functions |
|---|
Public companion functions
createFromBundle
funcreateFromBundle(bundle: Bundle): HeadlessWatchFaceClient
Public functions
addClientDisconnectListener
@AnyThread
funaddClientDisconnectListener(
listener: HeadlessWatchFaceClient.ClientDisconnectListener,
executor: Executor
): Unit
Registers a ClientDisconnectListener.
getUserStyleFlavors
open fungetUserStyleFlavors(): UserStyleFlavors
Returns the watch face's UserStyleFlavors if any.
| Throws | |
|---|---|
kotlin.RuntimeException |
if the watch face threw an exception while trying to service the request or there was a communication problem with watch face process. |
getUserStyleSchemaDigestHash
open fungetUserStyleSchemaDigestHash(): ByteArray
A SHA-1 MessageDigest hash of the UserStyleSchema. Note that for performance reasons where possible the resource id or url for Icons in the schema are used rather than the image bytes. This means that this hash should be considered insensitive to changes to the contents of icons between APK versions, which the user should account for accordingly.
This gives the same result as calling UserStyleSchema.computeDigestHash on userStyleSchema but is slightly faster since less data is passed over AIDL.
isConnectionAlive
@AnyThread
funisConnectionAlive(): Boolean
Returns true if the connection to the server side is alive.
removeClientDisconnectListener
@AnyThread
funremoveClientDisconnectListener(
listener: HeadlessWatchFaceClient.ClientDisconnectListener
): Unit
Removes a ClientDisconnectListener previously registered by addClientDisconnectListener.
renderComplicationToBitmap
@RequiresApi(value = 27)
funrenderComplicationToBitmap(
complicationSlotId: Int,
renderParameters: RenderParameters,
instant: Instant,
complicationData: ComplicationData,
userStyle: UserStyle?
): Bitmap?
Renders the androidx.wear.watchface.ComplicationSlot to a shared memory backed Bitmap with the given settings. The complication will be rendered at the same scale as it would be when the watch face is full screen.
| Parameters | |
|---|---|
complicationSlotId: Int |
The id of the complication to render |
renderParameters: RenderParameters |
The |
instant: Instant |
The |
complicationData: ComplicationData |
the |
userStyle: UserStyle? |
Optional |
| Returns | |
|---|---|
Bitmap? |
A shared memory backed |
renderWatchFaceToBitmap
@RequiresApi(value = 27)
funrenderWatchFaceToBitmap(
renderParameters: RenderParameters,
instant: Instant,
userStyle: UserStyle?,
slotIdToComplicationData: Map<Int, ComplicationData>?
): Bitmap
Renders the watchface to a shared memory backed Bitmap with the given settings.
| Parameters | |
|---|---|
renderParameters: RenderParameters |
The |
instant: Instant |
The |
userStyle: UserStyle? |
Optional |
slotIdToComplicationData: Map<Int, ComplicationData>? |
Map of |
toBundle
funtoBundle(): Bundle
Stores the underlying connection in a Bundle.
Public properties
complicationSlotsState
val complicationSlotsState: Map<Int, ComplicationSlotState>
Map of androidx.wear.watchface.ComplicationSlot ids to ComplicationSlotState for each ComplicationSlot registered with the watch face's ComplicationSlotsManager. The ComplicationSlotState is based on the initial state of each androidx.wear.watchface.ComplicationSlot plus any overrides from the default style's ComplicationSlotsUserStyleSetting. Because the style can't change, ComplicationSlotState is immutable for a headless watch face.
isRenderWatchFaceToSurfaceSupported
open val isRenderWatchFaceToSurfaceSupported: Boolean
Whether or not the watch face supports renderWatchFaceToSurface.
previewReferenceInstant
val previewReferenceInstant: Instant
The Instant to use when rendering previews.
userStyleSchema
val userStyleSchema: UserStyleSchema
The watch face's UserStyleSchema.