Package-level declarations

Types

Link copied to clipboard

A BoxScope with the SubtitleContentScale applied to the scope.

Link copied to clipboard

Content scale for Subtitles

Link copied to clipboard

Represents the type of surface used for video rendering.

Functions

Link copied to clipboard

Debug player view

Link copied to clipboard
fun PillarboxPlayerSurface(player: Player?, modifier: Modifier = Modifier, surfaceType: SurfaceType = SurfaceType.Surface)

A Composable function that displays a Player.

Link copied to clipboard
fun PlayerFrame(player: Player?, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, surfaceType: SurfaceType = SurfaceType.Surface, displayDebugView: Boolean = false, presentationState: PresentationState = rememberPresentationState(player = player, keepContentOnReset = false), surface: @Composable BoxScope.() -> Unit? = null, subtitle: @Composable SubtitleBoxScope.() -> Unit = { PlayerSubtitle( modifier = Modifier, player = player, ) }, shutter: @Composable BoxScope.() -> Unit = { Box( Modifier .fillMaxSize() .background(Color.Black) ) }, overlay: @Composable BoxScope.() -> Unit = {})

Provides a surface for a Player.

Link copied to clipboard
fun PlayerSubtitle(player: Player?, modifier: Modifier = Modifier, captionStyle: CaptionStyleCompat? = null, subtitleTextSize: SubtitleTextSize? = null)

A Composable function that displays an ExoPlayer SubtitleView. It observes the active cues from the provided player and displays them in a SubtitleView.

Link copied to clipboard
fun PlayerSurface(player: Player, modifier: Modifier = Modifier, scaleMode: ScaleMode = ScaleMode.Fit, contentAlignment: Alignment = Alignment.Center, defaultAspectRatio: Float? = null, displayDebugView: Boolean = false, surfaceType: SurfaceType = SurfaceType.Surface, surfaceContent: @Composable BoxScope.() -> Unit? = { ExoPlayerSubtitleView(player = player) })

A Composable function that displays a Player.