# OnPictureInPictureUiStateChangedProvider

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/app/OnPictureInPictureUiStateChangedProvider.kt+class:androidx.core.app.OnPictureInPictureUiStateChangedProvider) Added in [1.18.0-rc01](https://developer.android.com/jetpack/androidx/releases/core#1.18.0-rc01)

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/core/app/OnPictureInPictureUiStateChangedProvider "View this page in Java")


```
interface OnPictureInPictureUiStateChangedProvider
```

<br />

Known direct subclasses [PictureInPictureProvider](https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureProvider)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureProvider` | Provider interface to support PiP (Picture-in-Picture) functionalities. |

Known indirect subclasses [AppCompatActivity](https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity), [BaseCarAppActivity](https://developer.android.com/reference/kotlin/androidx/car/app/activity/BaseCarAppActivity), [CarAppActivity](https://developer.android.com/reference/kotlin/androidx/car/app/activity/CarAppActivity), [ComponentActivity](https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity), [FragmentActivity](https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity), [LauncherActivity](https://developer.android.com/reference/kotlin/androidx/car/app/activity/LauncherActivity), [PreviewActivity](https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/PreviewActivity)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appcompat/app/AppCompatActivity` | Base class for activities that wish to use some of the newer platform features on older Android devices. |
| `https://developer.android.com/reference/kotlin/androidx/car/app/activity/BaseCarAppActivity` | Core logic for CarAppLibrary Activity interaction with a host. |
| `https://developer.android.com/reference/kotlin/androidx/car/app/activity/CarAppActivity` | The class representing a car app activity in the main display. |
| `https://developer.android.com/reference/kotlin/androidx/activity/ComponentActivity` | Base class for activities that enables composition of higher level components. |
| `https://developer.android.com/reference/kotlin/androidx/fragment/app/FragmentActivity` | Base class for activities that want to use the support-based `https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment`. |
| `https://developer.android.com/reference/kotlin/androidx/car/app/activity/LauncherActivity` | This class handles providing the right launcher activity when running native applications and Car App Library applications. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/PreviewActivity` | Activity used to run `@Composable` previews from Android Studio. |

*** ** * ** ***

Interface for components that can dispatch calls from `https://developer.android.com/reference/android/app/Activity.html#onPictureInPictureUiStateChanged(android.app.PictureInPictureUiState)`.

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/core/app/OnPictureInPictureUiStateChangedProvider#addOnPictureInPictureUiStateChangedListener(androidx.core.util.Consumer)( listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer<https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat> )` Add a new listener that will get a callback associated with `https://developer.android.com/reference/android/app/Activity.html#onPictureInPictureUiStateChanged(android.app.PictureInPictureUiState)` with the new `https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/core/app/OnPictureInPictureUiStateChangedProvider#removeOnPictureInPictureUiStateChangedListener(androidx.core.util.Consumer)( listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer<https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat> )` Remove a previously added listener. |

## Public functions

### addOnPictureInPictureUiStateChangedListener

Added in [1.18.0-rc01](https://developer.android.com/jetpack/androidx/releases/core#1.18.0-rc01)

```
fun addOnPictureInPictureUiStateChangedListener(
    listener: Consumer<PictureInPictureUiStateCompat>
): Unit
```

Add a new listener that will get a callback associated with `https://developer.android.com/reference/android/app/Activity.html#onPictureInPictureUiStateChanged(android.app.PictureInPictureUiState)` with the new `https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer<https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat>` | The listener that should be called whenever `https://developer.android.com/reference/android/app/Activity.html#onPictureInPictureUiStateChanged(android.app.PictureInPictureUiState)` was called. |

### removeOnPictureInPictureUiStateChangedListener

Added in [1.18.0-rc01](https://developer.android.com/jetpack/androidx/releases/core#1.18.0-rc01)

```
fun removeOnPictureInPictureUiStateChangedListener(
    listener: Consumer<PictureInPictureUiStateCompat>
): Unit
```

Remove a previously added listener. It will not receive any future callbacks.

| Parameters |
|---|---|
| `listener: https://developer.android.com/reference/kotlin/androidx/core/util/Consumer<https://developer.android.com/reference/kotlin/androidx/core/app/PictureInPictureUiStateCompat>` | The listener previously added with `https://developer.android.com/reference/kotlin/androidx/core/app/OnPictureInPictureUiStateChangedProvider#addOnPictureInPictureUiStateChangedListener(androidx.core.util.Consumer)` that should be removed. |