androidx.media3.ui.compose

Annotations

SurfaceType

The type of surface used for media playbacks.

Constants summary

const Int

Surface type to create android.view.SurfaceView.
const Int

Surface type to create android.view.TextureView.

Top-level functions summary

Unit
@UnstableApi
@Composable
PlayerSurface(
    player: Player?,
    modifier: Modifier,
    surfaceType: @SurfaceType Int
)

Provides a dedicated drawing android.view.Surface for media playbacks using a Player.

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

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.