# InteractiveWatchFaceClient Artifact: [androidx.wear.watchface:watchface-client](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/client/InteractiveWatchFaceClient.kt+class:androidx.wear.watchface.client.InteractiveWatchFaceClient) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) *** ** * ** *** ``` interface InteractiveWatchFaceClient : AutoCloseable ```
*** ** * ** *** > [!CAUTION] > **This interface is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Controls a stateful remote interactive watch face. Typically this will be used for the current active watch face. Note clients should call `https://developer.android.com/reference/java/lang/AutoCloseable.html#close()` when finished. use Watch Face Format instead ## Summary | ### Nested types | |---| | `interface https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` **This interface is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `fun interface https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` **This interface is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | ### Constants | |---|---| | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_CANCEL()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_UP()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | ### Public functions | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/AnyThread [addClientDisconnectListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor))( listener: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener, executor: https://developer.android.com/reference/java/util/concurrent/Executor.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/WatchFaceClientExperimental [addOnWatchFaceColorsListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer))( executor: https://developer.android.com/reference/java/util/concurrent/Executor.html, listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[addOnWatchFaceReadyListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))( executor: https://developer.android.com/reference/java/util/concurrent/Executor.html, listener: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 30) [createRemoteWatchFaceViewHost](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#createRemoteWatchFaceViewHost(android.os.IBinder,kotlin.Int,kotlin.Int))( hostToken: https://developer.android.com/reference/android/os/IBinder.html, width: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, height: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?` | `[getComplicationIdAt](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationIdAt(kotlin.Int,kotlin.Int))(x: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, y: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleFlavors` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) [getUserStyleFlavors](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleFlavors())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[isComplicationDisplayPolicySupported](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isComplicationDisplayPolicySupported())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/AnyThread [isConnectionAlive](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isConnectionAlive())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[performAmbientTick](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#performAmbientTick())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/AnyThread [removeClientDisconnectListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener))( listener: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/WatchFaceClientExperimental [removeOnWatchFaceColorsListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceColorsListener(androidx.core.util.Consumer))(listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[removeOnWatchFaceReadyListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceReadyListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))( listener: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://developer.android.com/reference/android/graphics/Bitmap.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 27) [renderWatchFaceToBitmap](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map))( renderParameters: https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters, instant: https://developer.android.com/reference/java/time/Instant.html, userStyle: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle?, idAndComplicationData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html? )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[sendTouchEvent](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#sendTouchEvent(kotlin.Int,kotlin.Int,kotlin.Int))(xPosition: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, yPosition: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, tapType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[setWatchUiState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState))(watchUiState: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/WatchUiState)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[updateComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateComplicationData(kotlin.collections.Map))( slotIdToComplicationData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[updateWatchFaceInstance](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle))(newInstanceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, userStyle: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[updateWatchFaceInstance](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData))(newInstanceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, userStyle: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleData)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | ### Public properties | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#complicationSlotsState()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#contentDescriptionLabels()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#instanceId()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isRemoteWatchFaceViewHostSupported()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#overlayStyle()` **This property is deprecated.** OverlayStyle will be removed in a future release. | | `https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#previewReferenceInstant()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSchema` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#userStyleSchema()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | ### Inherited functions From [java.lang.AutoCloseable](https://developer.android.com/reference/java/lang/AutoCloseable.html) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[close](https://developer.android.com/reference/java/lang/AutoCloseable.html#close())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. ## Constants ### TAP_TYPE_CANCEL Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` const val TAP_TYPE_CANCEL: Int ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Indicates that a previous `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` event has been canceled. This generally happens when the watch face is touched but then a move or long press occurs. ### TAP_TYPE_DOWN Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` const val TAP_TYPE_DOWN: Int ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Indicates a "down" touch event on the watch face. ### TAP_TYPE_UP Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` const val TAP_TYPE_UP: Int ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Indicates that an "up" event on the watch face has occurred that has not been consumed by another activity. A `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` always occur first. This event will not occur if a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_CANCEL()` is sent. ## Public functions ### addClientDisconnectListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @AnyThread fun [addClientDisconnectListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor))(     listener: InteractiveWatchFaceClient.ClientDisconnectListener,     executor: Executor ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Registers a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener`. ### addOnWatchFaceColorsListener Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @WatchFaceClientExperimental open fun [addOnWatchFaceColorsListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer))(     executor: Executor,     listener: Consumer ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Registers a `https://developer.android.com/reference/kotlin/androidx/core/util/Consumer` which gets called initially with the current `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#watchfaceColors()` if known or `null` if not, and subsequently whenever the watch face's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#watchfaceColors()` change. | Parameters | |---|---| | `executor: https://developer.android.com/reference/java/util/concurrent/Executor.html` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which to run `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer)`. | | `listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer` | The `https://developer.android.com/reference/kotlin/androidx/core/util/Consumer` to run whenever the watch face's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#watchfaceColors()` change. | ### addOnWatchFaceReadyListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [addOnWatchFaceReadyListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))(     executor: Executor,     listener: InteractiveWatchFaceClient.OnWatchFaceReadyListener ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Registers a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` which gets called when the watch face is ready to render. Note in the event of the watch face disconnecting (e.g. due to a crash) the listener will never get called. Use `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` to observe disconnects. | Parameters | |---|---| | `executor: https://developer.android.com/reference/java/util/concurrent/Executor.html` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which to run `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener`. | | `listener: https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` to run when the watchface is ready to render. | ### createRemoteWatchFaceViewHost Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @RequiresApi(value = 30) open fun [createRemoteWatchFaceViewHost](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#createRemoteWatchFaceViewHost(android.os.IBinder,kotlin.Int,kotlin.Int))(     hostToken: IBinder,     width: @Px Int,     height: @Px Int ): RemoteWatchFaceViewHost? ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Constructs a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost` whose `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost#surfacePackage()` can be attached to a `https://developer.android.com/reference/android/view/SurfaceView.html` owned by the client with `https://developer.android.com/reference/android/view/SurfaceView.html#setChildSurfacePackage(android.view.SurfaceControlViewHost.SurfacePackage)`. The watch face will render into this view upon demand (see `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost#renderWatchFace(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map)`). This is more efficient than calling `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map)` multiple times, although there is some overhead (memory and cpu) to setting up a RemoteWatchFaceViewHost. Requires the watchface to be compiled with a compatible library, to check if that's the case use `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isRemoteWatchFaceViewHostSupported()`. | Parameters | |---|---| | `hostToken: https://developer.android.com/reference/android/os/IBinder.html` | The return value of View.getHostToken() | | `width: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The width of the view in pixels | | `height: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The height of the view in pixels | | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost?` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost` or null if the client has already been closed or if the watch face is not compatible. | ### getComplicationIdAt Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` open fun [getComplicationIdAt](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationIdAt(kotlin.Int,kotlin.Int))(x: @Px Int, y: @Px Int): Int? ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Returns the ID of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` at the given coordinates or `null` if there isn't one. Note this currently doesn't support Edge complications. ### getUserStyleFlavors Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @RequiresApi(value = 34) open fun [getUserStyleFlavors](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleFlavors())(): UserStyleFlavors ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Returns the watch face's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleFlavors`. | Throws | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-runtime-exception/index.html` | if the watch face threw an exception while trying to service the request or there was a communication problem with watch face process. | ### isComplicationDisplayPolicySupported Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` open fun [isComplicationDisplayPolicySupported](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isComplicationDisplayPolicySupported())(): Boolean ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Whether or not the watch face supports `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationDisplayPolicy`. If it doesn't then the client is responsible for emulating it by observing the state of the keyguard and sending NoData complications when the device becomes locked and subsequently restoring them when it becomes unlocked for affected complications. ### isConnectionAlive Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @AnyThread fun [isConnectionAlive](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#isConnectionAlive())(): Boolean ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Returns true if the connection to the server side is alive. ### performAmbientTick Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [performAmbientTick](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#performAmbientTick())(): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Triggers watch face rendering into the surface when in ambient mode. ### removeClientDisconnectListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @AnyThread fun [removeClientDisconnectListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener))(     listener: InteractiveWatchFaceClient.ClientDisconnectListener ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Removes a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` previously registered by `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor)`. ### removeOnWatchFaceColorsListener Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` @WatchFaceClientExperimental open fun [removeOnWatchFaceColorsListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceColorsListener(androidx.core.util.Consumer))(listener: Consumer): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Stops listening for events registered by `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer)`. ### removeOnWatchFaceReadyListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [removeOnWatchFaceReadyListener](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceReadyListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))(     listener: InteractiveWatchFaceClient.OnWatchFaceReadyListener ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Stops listening for events registered by `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener)`. ### renderWatchFaceToBitmap ``` @RequiresApi(value = 27) fun [renderWatchFaceToBitmap](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map))(     renderParameters: RenderParameters,     instant: Instant,     userStyle: UserStyle?,     idAndComplicationData: Map? ): Bitmap ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Renders the watchface to a shared memory backed `https://developer.android.com/reference/android/graphics/Bitmap.html` with the given settings. Note this will be fairly slow since either software canvas or glReadPixels will be invoked. | Parameters | |---|---| | `renderParameters: https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters` to draw with. | | `instant: https://developer.android.com/reference/java/time/Instant.html` | The `https://developer.android.com/reference/java/time/Instant.html` render with. | | `userStyle: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle?` | Optional `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle` to render with, if null the current style is used. | | `idAndComplicationData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html?` | Map of complication ids to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData` to render with, or if null then the existing complication data if any is used. | | Returns | |---|---| | `https://developer.android.com/reference/android/graphics/Bitmap.html` | A shared memory backed `https://developer.android.com/reference/android/graphics/Bitmap.html` containing a screenshot of the watch face with the given settings. | ### sendTouchEvent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [sendTouchEvent](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#sendTouchEvent(kotlin.Int,kotlin.Int,kotlin.Int))(xPosition: @Px Int, yPosition: @Px Int, tapType: Int): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Sends a tap event to the watch face for processing. | Parameters | |---|---| | `xPosition: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The x-coordinate of the tap in pixels | | `yPosition: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The y-coordinate of the tap in pixels | | `tapType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/TapTypeIntDef` of the event Value is one of the following: - `0` - `2` - `1`
| ### setWatchUiState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [setWatchUiState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState))(watchUiState: WatchUiState): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Updates the watch faces `https://developer.android.com/reference/kotlin/androidx/wear/watchface/data/WatchUiState`. NB `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState)` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` can be called in any order. ### updateComplicationData ``` fun [updateComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateComplicationData(kotlin.collections.Map))(     slotIdToComplicationData: Map ): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Sends new `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData` to the watch face. Note this doesn't have to be a full update, it's possible to update just one complication at a time, but doing so may result in a less visually clean transition. | Parameters | |---|---| | `slotIdToComplicationData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData` for each `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot`. | ### updateWatchFaceInstance Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [updateWatchFaceInstance](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle))(newInstanceId: String, userStyle: UserStyle): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Renames this instance to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` (must be unique, usually this would be different from the old ID but that's not a requirement). Sets the current `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle` and clears any complication data. Setting the new UserStyle may have a side effect of enabling or disabling complicationSlots, which will be visible via `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/ComplicationSlotState#isEnabled()`. NB `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState)` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` can be called in any order. ### updateWatchFaceInstance Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` fun [updateWatchFaceInstance](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData))(newInstanceId: String, userStyle: UserStyleData): Unit ``` > [!CAUTION] > **This function is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Renames this instance to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData)` (must be unique, usually this would be different from the old ID but that's not a requirement). Sets the current `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyle` represented as a \[UserStyleData\> and clears any complication data. Setting the new UserStyle may have a side effect of enabling or disabling complicationSlots, which will be visible via `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/ComplicationSlotState#isEnabled()`. ## Public properties ### complicationSlotsState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val complicationSlotsState: Map ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Map of `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` ids to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/ComplicationSlotState` for each `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` registered with the watch face's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlotsManager`. The ComplicationSlotState is based on the initial state of each `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` plus any overrides from a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting`. As a consequence ComplicationSlotState may update based on style changes. ### contentDescriptionLabels Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val contentDescriptionLabels: List ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Returns the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ContentDescriptionLabel`s describing the watch face, for the use by screen readers. ### instanceId Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val instanceId: String ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Returns the ID of this watch face instance. ### isRemoteWatchFaceViewHostSupported Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` open val isRemoteWatchFaceViewHostSupported: Boolean ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Whether or not the watch face supports `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/RemoteWatchFaceViewHost`. ### overlayStyle Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) ``` open val overlayStyle: OverlayStyle ``` > [!CAUTION] > **This property is deprecated.** > OverlayStyle will be removed in a future release. The watchface's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/OverlayStyle` which may be null. Note while this plumbing got built, it was never used by the system ui on any platform and it will be removed. ### previewReferenceInstant Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val previewReferenceInstant: Instant ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff The UTC reference preview time for this watch face in milliseconds since the epoch. ### userStyleSchema Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val userStyleSchema: UserStyleSchema ``` > [!CAUTION] > **This property is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff The watch face's `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSchema`.