# EmbeddingConfiguration

# EmbeddingConfiguration

Artifact:[androidx.window:window](https://developer.android.com/jetpack/androidx/releases/window)  
[View Source](https://cs.android.com/search?q=file:androidx/window/embedding/EmbeddingConfiguration.kt+class:androidx.window.embedding.EmbeddingConfiguration)  
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/EmbeddingConfiguration "View this page in Java")

<br />

```
class EmbeddingConfiguration
```

<br />

*** ** * ** ***

Configurations of Activity Embedding environment that defines how the embedded Activities behave.  

|                                                                                                   See also                                                                                                    |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [EmbeddingConfiguration.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.Builder)                                                                     |   |
| [setEmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityEmbeddingController#setEmbeddingConfiguration(androidx.window.embedding.EmbeddingConfiguration)) |   |

## Summary

|                                                                                                                                                ### Nested types                                                                                                                                                 |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[EmbeddingConfiguration.Builder](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.Builder) Builder for creating an instance of[EmbeddingConfiguration](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration). |
| `class `[EmbeddingConfiguration.DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior) The area of dimming to apply.                                                                                                                 |

|                                        ### 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/EmbeddingConfiguration#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration#hashCode())`()`                                                                                            |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration#toString())`()`                                                                                            |

|                                                                   ### Public properties                                                                   |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [EmbeddingConfiguration.DimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration.DimAreaBehavior) | [dimAreaBehavior](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration#dimAreaBehavior()) The requested dim area behavior.                        |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                       | [isAutoSaveEmbeddingState](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingConfiguration#isAutoSaveEmbeddingState()) Is auto-save embedding state enabled. |

## Public functions

### equals

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

### hashCode

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

### toString

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

## Public properties

### dimAreaBehavior

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

```
val dimAreaBehavior: EmbeddingConfiguration.DimAreaBehavior
```

The requested dim area behavior.  

### isAutoSaveEmbeddingState

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

```
val isAutoSaveEmbeddingState: Boolean
```

Is auto-save embedding state enabled.