# PreviewScreenshotParams

# PreviewScreenshotParams

Artifact:[androidx.wear.watchface:watchface-editor](https://developer.android.com/jetpack/androidx/releases/wear-watchface)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/editor/WatchFaceEditorContract.kt+class:androidx.wear.watchface.editor.PreviewScreenshotParams)  
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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/watchface/editor/PreviewScreenshotParams "View this page in Java")

<br />

```
class PreviewScreenshotParams
```

<br />

*** ** * ** ***

| **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

Parameters for an optional final screenshot taken by[EditorSession](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/EditorSession)upon exit and reported via[EditorState](https://developer.android.com/reference/kotlin/androidx/wear/watchface/client/EditorState).

use Watch Face Format instead

## Summary

|                                                                                                                                                                                                                                                                        ### Public constructors                                                                                                                                                                                                                                                                        |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ~~[PreviewScreenshotParams](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#PreviewScreenshotParams(androidx.wear.watchface.RenderParameters,java.time.Instant))~~`(` ` renderParameters: `[RenderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters)`,` ` instant: `[Instant](https://developer.android.com/reference/java/time/Instant.html) `)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | ~~[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#equals(kotlin.Any))~~`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | ~~[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#hashCode())~~`()` **This function is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                                                                                            |

|                                            ### Public properties                                            |
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Instant](https://developer.android.com/reference/java/time/Instant.html)                                   | [instant](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#instant()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead.                   |
| [RenderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters) | [renderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#renderParameters()) **This property is deprecated.**AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### PreviewScreenshotParams

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)  

```
[PreviewScreenshotParams](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#PreviewScreenshotParams(androidx.wear.watchface.RenderParameters,java.time.Instant))(
    renderParameters: RenderParameters,
    instant: Instant
)
```
| **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                                                            |
|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| `renderParameters: `[RenderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters) | The[RenderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters)to use when rendering the screen shot |
| `instant: `[Instant](https://developer.android.com/reference/java/time/Instant.html)                                            | The[Instant](https://developer.android.com/reference/java/time/Instant.html)to render with.                                                         |

## Public functions

### equals

```
open operator fun [equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#equals(kotlin.Any))(other: Any?): Boolean
```
| **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  

### hashCode

```
open fun [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/editor/PreviewScreenshotParams#hashCode())(): Int
```
| **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  

## Public properties

### instant

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 instant: Instant
```
| **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[Instant](https://developer.android.com/reference/java/time/Instant.html)to render with.  

### renderParameters

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 renderParameters: RenderParameters
```
| **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[RenderParameters](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters)to use when rendering the screen shot