EmbeddedPhotoPicker

Functions summary

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

Compose entry-point into the EmbeddedPhotoPicker.

Functions

EmbeddedPhotoPicker

@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 EmbeddedPhotoPickerProvider and interacts with the provided 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 rememberEmbeddedPhotoPickerState, 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: EmbeddedPhotoPickerState

The state object for the EmbeddedPhotoPicker which can be manually implemented, or a default implementation may be obtained via the rememberEmbeddedPhotoPickerState composable.
modifier: Modifier = Modifier

An optional Modifier for the root view of the PhotoPicker.
provider: EmbeddedPhotoPickerProvider? = null

An optional EmbeddedPhotoPickerProvider that will be used to connect to the PhotoPicker service. If null, the platform default will be used.
embeddedPhotoPickerFeatureInfo: EmbeddedPhotoPickerFeatureInfo = DEFAULT_FEATURE_INFO

A set of features that will be provided to the PhotoPicker when a session is started.