ContentFrame

Functions summary

Unit

@UnstableApi
@Composable
ContentFrame(
    player: Player?,
    modifier: Modifier,
    surfaceType: @SurfaceType Int,
    contentScale: ContentScale,
    keepContentOnReset: Boolean,
    shutter: @Composable () -> Unit
)

A container for displaying media content from a Player.

Functions

ContentFrame

Artifact: androidx.media3:media3-ui-compose

View Source

@UnstableApi
@Composable
fun ContentFrame(
    player: Player?,
    modifier: Modifier = Modifier,
    surfaceType: @SurfaceType Int = SURFACE_TYPE_SURFACE_VIEW,
    contentScale: ContentScale = ContentScale.Fit,
    keepContentOnReset: Boolean = false,
    shutter: @Composable () -> Unit = { Box(Modifier.fillMaxSize().background(Color.Black)) }
): Unit

A container for displaying media content from a Player.

This composable handles the underlying PlayerSurface for video playback, resizing the video based on the provided ContentScale, and displaying a shutter according to the PresentationState based off the Player.

Parameters
`player: Player?`	The attached `Player` that provides media to this content frame.
`modifier: Modifier = Modifier`	The `Modifier` to be applied to the layout.
`surfaceType: @SurfaceType Int = SURFACE_TYPE_SURFACE_VIEW`	The type of surface to use for video playback. Can be either `SURFACE_TYPE_SURFACE_VIEW` or `SURFACE_TYPE_TEXTURE_VIEW`.
`contentScale: ContentScale = ContentScale.Fit`	The `ContentScale` strategy for the container.
`keepContentOnReset: Boolean = false`	If `true`, the last rendered frame will remain visible when the player is reset. If `false`, the surface will be cleared.
`shutter: @Composable () -> Unit = { Box(Modifier.fillMaxSize().background(Color.Black)) }`	A composable that is displayed when the video surface needs to be covered. By default, this is a black background.