EmbeddingConfiguration.Builder

Artifact: androidx.window:window

View Source

Added in 1.4.0-beta01

---

Kotlin |Java

public final class EmbeddingConfiguration.Builder

---

Builder for creating an instance of EmbeddingConfiguration.

Summary

Public constructors
Builder()

Public methods
final @NonNull EmbeddingConfiguration	build() Builds aEmbeddingConfiguration instance.
final @NonNull EmbeddingConfiguration.Builder	@RequiresWindowSdkExtension(version = 5) setDimAreaBehavior(@NonNull EmbeddingConfiguration.DimAreaBehavior area) Sets the dim area behavior.

Public constructors

Builder

Added in 1.4.0-beta01

public Builder()

Public methods

build

Added in 1.4.0-beta01

public final @NonNull EmbeddingConfiguration build()

Builds aEmbeddingConfiguration instance.

Returns
@NonNull EmbeddingConfiguration	The new EmbeddingConfiguration instance.

setDimAreaBehavior

Added in 1.4.0-beta01

@RequiresWindowSdkExtension(version = 5)
public final @NonNull EmbeddingConfiguration.Builder setDimAreaBehavior(@NonNull EmbeddingConfiguration.DimAreaBehavior area)

Sets the dim area behavior. By default, the DimAreaBehavior.UNDEFINED is used if not set.

This can be supported only if the Window Extensions version of the target device is equals or higher than required API level. Otherwise, it would be no-op on a target device that has lower API level.

Parameters
@NonNull EmbeddingConfiguration.DimAreaBehavior area	The dim area.

Returns
@NonNull EmbeddingConfiguration.Builder	This Builder