androidx.media3.ui.compose
Annotations
SurfaceType |
The type of surface used for media playbacks. |
Constants summary
const Int |
Surface type to create |
const Int |
Surface type to create |
Top-level functions summary
Unit |
@UnstableApiA container for displaying media content from a |
Unit |
@UnstableApiProvides a dedicated drawing |
Constants
SURFACE_TYPE_SURFACE_VIEW
@UnstableApi
const val SURFACE_TYPE_SURFACE_VIEW = 1: Int
Surface type to create android.view.SurfaceView.
SURFACE_TYPE_TEXTURE_VIEW
@UnstableApi
const val SURFACE_TYPE_TEXTURE_VIEW = 2: Int
Surface type to create android.view.TextureView.
Top-level functions
ContentFrame
@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 |
modifier: Modifier = Modifier |
The |
surfaceType: @SurfaceType Int = SURFACE_TYPE_SURFACE_VIEW |
The type of surface to use for video playback. Can be either |
contentScale: ContentScale = ContentScale.Fit |
The |
keepContentOnReset: Boolean = false |
If |
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. |
PlayerSurface
@UnstableApi
@Composable
fun PlayerSurface(
player: Player?,
modifier: Modifier = Modifier,
surfaceType: @SurfaceType Int = SURFACE_TYPE_SURFACE_VIEW
): Unit
Provides a dedicated drawing android.view.Surface for media playbacks using a Player.
The player's video output is displayed with either a android.view.SurfaceView or a android.view.TextureView.
Player takes care of attaching the rendered output to the android.view.Surface and clearing it, when it is destroyed.
See Choosing a surface type for more information.