ErrorText

Functions summary

Unit
@UnstableApi
@Composable
ErrorText(
    player: Player?,
    modifier: Modifier,
    color: Color,
    customErrorMessage: CharSequence?,
    errorMessageProvider: ErrorMessageProvider<PlaybackException>?
)

A Composable for displaying an error message overlay on top of the player.

Functions

ErrorText

@UnstableApi
@Composable
fun ErrorText(
    player: Player?,
    modifier: Modifier = Modifier,
    color: Color = Color.Unspecified,
    customErrorMessage: CharSequence? = null,
    errorMessageProvider: ErrorMessageProvider<PlaybackException>? = rememberDefaultErrorMessageProvider()
): Unit

A Composable for displaying an error message overlay on top of the player.

Parameters
player: Player?

The Player instance to observe for errors.
modifier: Modifier = Modifier

The Modifier to be applied to the layout.
color: Color = Color.Unspecified

The Color of the error text.
customErrorMessage: CharSequence? = null

An optional custom message to display permanently.
errorMessageProvider: ErrorMessageProvider<PlaybackException>? = rememberDefaultErrorMessageProvider()

An ErrorMessageProvider used to format the PlaybackException. Defaults to a provider with localization support.