Player

@UnstableApi
@Composable
fun Player(player: Player?, modifier: Modifier = Modifier): Unit

A composable that provides a basic player UI layout with a shutter and hidden default controls.

This composable consists of a ContentFrame that handles the rendering of the player's video, overlaid with a shutter and the standard Material3 layouts provided by PlayerDefaults. This includes PlayerDefaults.TopControls, PlayerDefaults.CenterControls, and PlayerDefaults.BottomControls.

The controls are always hidden, because showing them permanently would occlude the video. To show and hide them, for example when the user taps the player, use the overload that accepts showControls. That overload also allows customizing the UI components.

@ExperimentalApi
@Composable
fun Player(
    player: Player?,
    modifier: Modifier = Modifier,
    surfaceType: @SurfaceType Int = SURFACE_TYPE_SURFACE_VIEW,
    contentScale: ContentScale = ContentScale.Fit,
    alignment: Alignment = Alignment.Center,
    keepContentOnReset: Boolean = false,
    subtitles: @Composable () -> Unit = { Subtitles(player) },
    shutter: @Composable () -> Unit = PlayerDefaults::Shutter,
    artwork: (@Composable () -> Unit)? = {
    Artwork(
      player,
      modifier = Modifier.fillMaxSize(),
      alignment = alignment,
      contentScale = contentScale,
    )
  },
    showControls: Boolean = false,
    topControls: (@Composable BoxScope.() -> Unit)? = {
    PlayerDefaults.TopControls(player, showControls, Modifier.fillMaxWidth())
  },
    centerControls: (@Composable BoxScope.() -> Unit)? = {
    PlayerDefaults.CenterControls(player, showControls, Modifier.fillMaxWidth())
  },
    bottomControls: (@Composable BoxScope.() -> Unit)? = {
    PlayerDefaults.BottomControls(player, showControls)
  },
    errorOverlay: (@Composable BoxScope.() -> Unit)? = { PlayerDefaults.ErrorOverlay(player) }
): Unit

A composable that provides a basic player UI layout, combining a ContentFrame for displaying player content with customizable controls and a shutter.

This composable is designed to be a flexible container for building player interfaces. It consists of a ContentFrame that handles the rendering of the player's video, overlaid with optional controls and a shutter.

By default, this component uses the standard Material3 layouts provided by PlayerDefaults. This includes PlayerDefaults.TopControls, PlayerDefaults.CenterControls, and PlayerDefaults.BottomControls. You can deeply customize the player UI by providing your own composables to the slots of this composable, or by utilizing the PlayerDefaults layouts and overriding only specific slots within them.

The Player natively manages keyboard focus traversal between its control slots. Each provided control slot (topControls, centerControls, and bottomControls) is wrapped in a focus group. 1-dimensional focus traversal (e.g., using the Tab key) is configured to move sequentially from the top controls, to the center controls, and down to the bottom controls. Backward traversal moves in the reverse order.