# EmbeddedPhotoPicker

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) @https://developer.android.com/reference/kotlin/androidx/annotation/RequiresExtension(extension = 34, version = 15) @https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/ExperimentalPhotoPickerComposeApi https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/EmbeddedPhotoPicker.composable#EmbeddedPhotoPicker(androidx.photopicker.embedded.compose.EmbeddedPhotoPickerState,androidx.compose.ui.Modifier,android.widget.photopicker.EmbeddedPhotoPickerProvider,android.widget.photopicker.EmbeddedPhotoPickerFeatureInfo)( state: https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/EmbeddedPhotoPickerState, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, provider: https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerProvider.html?, embeddedPhotoPickerFeatureInfo: https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo.html )` Compose entry-point into the EmbeddedPhotoPicker. |

## Functions

### EmbeddedPhotoPicker

Artifact: [androidx.photopicker:photopicker-embedded-compose](https://developer.android.com/jetpack/androidx/releases/photopicker) [View Source](https://cs.android.com/search?q=file:androidx/photopicker/embedded/compose/EmbeddedPhotoPicker.kt+function:EmbeddedPhotoPicker) Added in [1.0.0-alpha03](https://developer.android.com/jetpack/androidx/releases/photopicker#1.0.0-alpha03)

```
@Composable
@RequiresApi(value = 34)
@RequiresExtension(extension = 34, version = 15)
@ExperimentalPhotoPickerComposeApi
fun EmbeddedPhotoPicker(
    state: EmbeddedPhotoPickerState,
    modifier: Modifier = Modifier,
    provider: EmbeddedPhotoPickerProvider? = null,
    embeddedPhotoPickerFeatureInfo: EmbeddedPhotoPickerFeatureInfo = DEFAULT_FEATURE_INFO
): Unit
```

Compose entry-point into the EmbeddedPhotoPicker. This composable hosts a remote view from the `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerProvider.html` and interacts with the provided `https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/EmbeddedPhotoPickerState` and coordinates the state between the local compose view and remote view.

If a terminal session error occurs during the session, it is reported to the client via the `onError` callback configured in `https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/rememberEmbeddedPhotoPickerState.composable#rememberEmbeddedPhotoPickerState(kotlin.Boolean,kotlin.collections.Set,kotlin.Function1,kotlin.Function1,kotlin.Function1,kotlin.Function0)`, and the session terminates cleanly. In this case, the client should remove or close the composable and display fallback UI or prompt the user to retry.

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/EmbeddedPhotoPickerState` | The state object for the EmbeddedPhotoPicker which can be manually implemented, or a default implementation may be obtained via the `https://developer.android.com/reference/kotlin/androidx/photopicker/embedded/compose/rememberEmbeddedPhotoPickerState.composable#rememberEmbeddedPhotoPickerState(kotlin.Boolean,kotlin.collections.Set,kotlin.Function1,kotlin.Function1,kotlin.Function1,kotlin.Function0)` composable. |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | An optional `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` for the root view of the PhotoPicker. |
| `provider: https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerProvider.html? = null` | An optional `https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerProvider.html` that will be used to connect to the PhotoPicker service. If null, the platform default will be used. |
| `embeddedPhotoPickerFeatureInfo: https://developer.android.com/reference/android/widget/photopicker/EmbeddedPhotoPickerFeatureInfo.html = DEFAULT_FEATURE_INFO` | A set of features that will be provided to the PhotoPicker when a session is started. |