# EmbeddingAnimationParams

# EmbeddingAnimationParams

Artifact:[androidx.window:window](https://developer.android.com/jetpack/androidx/releases/window)  
[View Source](https://cs.android.com/search?q=file:androidx/window/embedding/EmbeddingAnimationParams.kt+class:androidx.window.embedding.EmbeddingAnimationParams)  
Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/window/embedding/EmbeddingAnimationParams "View this page in Java")

<br />

```
class EmbeddingAnimationParams
```

<br />

*** ** * ** ***

Parameters to be used for window transition animations for embedding activities.  

|                                                                             See also                                                                             |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [EmbeddingAnimationParams.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.Builder)                    |   |
| [animationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes#animationParams())                                    |   |
| [EmbeddingAnimationBackground](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationBackground)                            |   |
| [createColorBackground](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationBackground#createColorBackground(kotlin.Int)) |   |
| [DEFAULT](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationBackground#DEFAULT())                                       |   |

## Summary

|                                                                                                                                                    ### Nested types                                                                                                                                                     |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[EmbeddingAnimationParams.AnimationSpec](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.AnimationSpec) The animation to use when an activity transitions (e.g. open, close, or change).                                                                      |
| `class `[EmbeddingAnimationParams.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.Builder) Builder for creating an instance of[EmbeddingAnimationParams](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams). |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` Determines whether this object has the same animation parameters as the compared object. |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#hashCode())`()` Returns a hash code for this`EmbeddingAnimationParams`object.                                                                                                                       |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#toString())`()` A string representation of this`EmbeddingAnimationParams`object.                                                                                                                    |

|                                                                   ### Public properties                                                                   |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [EmbeddingAnimationBackground](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationBackground)                     | [animationBackground](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#animationBackground()) the animation background to use during the animation of the split involving this`EmbeddingAnimationParams`object if the animation requires a background. |
| [EmbeddingAnimationParams.AnimationSpec](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.AnimationSpec) | [changeAnimation](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#changeAnimation()) the animation spec to use for change transitions (when an activity resizes or moves).                                                                            |
| [EmbeddingAnimationParams.AnimationSpec](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.AnimationSpec) | [closeAnimation](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#closeAnimation()) the animation spec to use for close transitions (when finishing/exiting an activity or when an activity moves to back).                                            |
| [EmbeddingAnimationParams.AnimationSpec](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams.AnimationSpec) | [openAnimation](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAnimationParams#openAnimation()) the animation spec to use for open transitions (when starting/entering an activity or when an activity moves to front).                                              |

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

Determines whether this object has the same animation parameters as the compared object.  

|                                       Parameters                                        |
|-----------------------------------------------------------------------------------------|---------------------------------------|
| `other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?` | the object to compare to this object. |

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | true if the objects have the same animation parameters, false otherwise. |

### hashCode

```
open fun hashCode(): Int
```

Returns a hash code for this`EmbeddingAnimationParams`object.  

|                                   Returns                                   |
|-----------------------------------------------------------------------------|--------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | the hash code for this object. |

### toString

```
open fun toString(): String
```

A string representation of this`EmbeddingAnimationParams`object.  

|                                      Returns                                      |
|-----------------------------------------------------------------------------------|------------------------------------------|
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | the string representation of the object. |

## Public properties

### animationBackground

Added in[1.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)  

```
val animationBackground: EmbeddingAnimationBackground
```

the animation background to use during the animation of the split involving this`EmbeddingAnimationParams`object if the animation requires a background. The default is to use the current theme window background color.  

### changeAnimation

Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/window#1.5.0)  

```
val changeAnimation: EmbeddingAnimationParams.AnimationSpec
```

the animation spec to use for change transitions (when an activity resizes or moves).  

### closeAnimation

Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/window#1.5.0)  

```
val closeAnimation: EmbeddingAnimationParams.AnimationSpec
```

the animation spec to use for close transitions (when finishing/exiting an activity or when an activity moves to back).  

### openAnimation

Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/window#1.5.0)  

```
val openAnimation: EmbeddingAnimationParams.AnimationSpec
```

the animation spec to use for open transitions (when starting/entering an activity or when an activity moves to front).