# WatchState Artifact: [androidx.wear.watchface:watchface](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/WatchState.kt+class:androidx.wear.watchface.WatchState) 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) *** ** * ** ***
``` class WatchState ```
*** ** * ** *** > [!CAUTION] > **This class is deprecated.** > AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff Describes the current state of the wearable including some hardware details such as whether or not it supports burn in prevention and low-bit ambient. ## Summary | ### Public constructors | |---| | `[WatchState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#WatchState(kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlin.Boolean,kotlin.Boolean,kotlin.Long,kotlin.Long,kotlin.Int,kotlin.Boolean))( interruptionFilter: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isAmbient: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isBatteryLowAndNotCharging: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isVisible: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, hasLowBitAmbient: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, hasBurnInProtection: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, analogPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, digitalPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, chinHeight: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, isHeadless: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` **This function is deprecated.** WatchState constructors without watchFaceInstanceId are deprecated | | `[WatchState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#WatchState(kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlin.Boolean,kotlin.Boolean,kotlin.Long,kotlin.Long,kotlin.Int,kotlin.Boolean,kotlinx.coroutines.flow.StateFlow))( interruptionFilter: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isAmbient: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isBatteryLowAndNotCharging: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, isVisible: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html, hasLowBitAmbient: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, hasBurnInProtection: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, analogPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, digitalPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, chinHeight: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, isHeadless: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, watchFaceInstanceId: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | ### Public properties | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#analogPreviewReferenceTimeMillis()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `@https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#chinHeight()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#digitalPreviewReferenceTimeMillis()` **This property 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/wear/watchface/WatchState#hasBurnInProtection()` **This property 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/wear/watchface/WatchState#hasLowBitAmbient()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#interruptionFilter()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#isAmbient()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#isBatteryLowAndNotCharging()` **This property 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/wear/watchface/WatchState#isHeadless()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#isVisible()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#watchFaceInstanceId()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | ## Public constructors ### WatchState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) ``` [WatchState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#WatchState(kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlin.Boolean,kotlin.Boolean,kotlin.Long,kotlin.Long,kotlin.Int,kotlin.Boolean))(     interruptionFilter: StateFlow,     isAmbient: StateFlow,     isBatteryLowAndNotCharging: StateFlow,     isVisible: StateFlow,     hasLowBitAmbient: Boolean,     hasBurnInProtection: Boolean,     analogPreviewReferenceTimeMillis: Long,     digitalPreviewReferenceTimeMillis: Long,     chinHeight: Int,     isHeadless: Boolean ) ``` > [!CAUTION] > **This function is deprecated.** > WatchState constructors without watchFaceInstanceId are deprecated ### WatchState Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` [WatchState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState#WatchState(kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlinx.coroutines.flow.StateFlow,kotlin.Boolean,kotlin.Boolean,kotlin.Long,kotlin.Long,kotlin.Int,kotlin.Boolean,kotlinx.coroutines.flow.StateFlow))(     interruptionFilter: StateFlow,     isAmbient: StateFlow,     isBatteryLowAndNotCharging: StateFlow,     isVisible: StateFlow,     hasLowBitAmbient: Boolean,     hasBurnInProtection: Boolean,     analogPreviewReferenceTimeMillis: Long,     digitalPreviewReferenceTimeMillis: Long,     chinHeight: @Px Int,     isHeadless: Boolean,     watchFaceInstanceId: StateFlow ) ``` > [!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 | Parameters | |---|---| | `interruptionFilter: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | The current user interruption settings. See `https://developer.android.com/reference/android/app/NotificationManager.html`. This is initially `null` because the watch face is created before the system has sent the state. Based on the value the watch face should adjust the amount of information it displays. For example, if it displays the number of pending emails, it should hide it if interruptionFilter is equal to `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`. `interruptionFilter` can be `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALL`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALARMS`, or `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_UNKNOWN`. | | `isAmbient: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | Whether or not the watch is in ambient mode. This is initially `null` because the watch face is created before the system has sent the state. The order in which ambient vs style changes are reported is not guaranteed. Likewise the order of isAmbient flow callbacks and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)` calls is not defined. For rendering please refer to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters#drawMode()` instead of isAmbient because you might receive requests for rendering non-ambient frames while the watch is ambient (e.g. editing from the companion phone). | | `isBatteryLowAndNotCharging: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | Whether or not we should conserve power due to a low battery which isn't charging. This is initially `null` because the watch face is created before the system has sent the state. Only valid if `https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#hideNotificationIndicator` is true. | | `isVisible: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | Whether or not the watch face is visible. This is initially `null` because the watch face is created before the system has sent the state. | | `hasLowBitAmbient: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether or not the watch hardware supports low bit ambient support. | | `hasBurnInProtection: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether or not the watch hardware supports burn in protection. | | `analogPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | UTC reference time for previews of analog watch faces in milliseconds since the epoch. | | `digitalPreviewReferenceTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | UTC reference time for previews of digital watch faces in milliseconds since the epoch. | | `chinHeight: @https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | the size, in pixels, of the chin or zero if the device does not have a chin. A chin is a section at the bottom of a circular display that is visible due to hardware limitations. | | `isHeadless: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether or not this is a headless watchface. | | `watchFaceInstanceId: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/index.html` | The ID associated with the watch face instance. Note there may be more than one instance associated with a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceService`. See `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/WatchFaceId` for more details. ```kotlin @deprecated use Watch Face Format instead ``` | ## Public properties ### analogPreviewReferenceTimeMillis 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 analogPreviewReferenceTimeMillis: Long ``` > [!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 UTC reference time for previews of analog watch faces in milliseconds since the epoch. ### chinHeight 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 chinHeight: @Px 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 the size, in pixels, of the chin or zero if the device does not have a chin. A chin is a section at the bottom of a circular display that is visible due to hardware limitations. ### digitalPreviewReferenceTimeMillis 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 digitalPreviewReferenceTimeMillis: Long ``` > [!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 UTC reference time for previews of digital watch faces in milliseconds since the epoch. ### hasBurnInProtection 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) ``` val hasBurnInProtection: 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 hardware supports burn in protection. ### hasLowBitAmbient 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) ``` val hasLowBitAmbient: 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 hardware supports low bit ambient support. ### interruptionFilter 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 interruptionFilter: StateFlow ``` > [!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 current user interruption settings. See `https://developer.android.com/reference/android/app/NotificationManager.html`. This is initially `null` because the watch face is created before the system has sent the state. Based on the value the watch face should adjust the amount of information it displays. For example, if it displays the number of pending emails, it should hide it if interruptionFilter is equal to `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`. `interruptionFilter` can be `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALL`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALARMS`, or `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_UNKNOWN`. ### isAmbient 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 isAmbient: StateFlow ``` > [!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 is in ambient mode. This is initially `null` because the watch face is created before the system has sent the state. The order in which ambient vs style changes are reported is not guaranteed. Likewise the order of isAmbient flow callbacks and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)` calls is not defined. For rendering please refer to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters#drawMode()` instead of isAmbient because you might receive requests for rendering non-ambient frames while the watch is ambient (e.g. editing from the companion phone). ### isBatteryLowAndNotCharging Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val isBatteryLowAndNotCharging: StateFlow ``` > [!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 we should conserve power due to a low battery which isn't charging. This is initially `null` because the watch face is created before the system has sent the state. Only valid if `https://developer.android.com/reference/android/support/wearable/watchface/WatchFaceStyle.html#hideNotificationIndicator` is true. ### isHeadless 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 isHeadless: 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 this is a headless watchface. ### isVisible 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 isVisible: StateFlow ``` > [!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 is visible. This is initially `null` because the watch face is created before the system has sent the state. ### watchFaceInstanceId Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) ``` val watchFaceInstanceId: StateFlow ``` > [!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 ID associated with the watch face instance. Note there may be more than one instance associated with a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceService`. See `https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/WatchFaceId` for more details. ```kotlin @deprecated use Watch Face Format instead ```