Video

data class Video(val isPlaying: MutableState<Boolean>, val aspectRatio: SkapaAspectRatio = SkapaAspectRatio.Ratio1by1, val contentDescription: String?, val playButtonParams: VideoPlayerButtonParams.PlayButtonParams, val fullScreenParams: VideoPlayerButtonParams.FullScreenParams? = null, val transcriptionParams: VideoPlayerButtonParams.TranscriptionParams? = null, val onBackgroundPress: () -> Unit? = null, val player: @Composable () -> Unit) : CompactMediaContainer

Video content for the media container.

Constructors

Link copied to clipboard
constructor(isPlaying: MutableState<Boolean>, aspectRatio: SkapaAspectRatio = SkapaAspectRatio.Ratio1by1, contentDescription: String?, playButtonParams: VideoPlayerButtonParams.PlayButtonParams, fullScreenParams: VideoPlayerButtonParams.FullScreenParams? = null, transcriptionParams: VideoPlayerButtonParams.TranscriptionParams? = null, onBackgroundPress: () -> Unit? = null, player: @Composable () -> Unit)

Properties

Link copied to clipboard

The aspect ratio of the video player.

Link copied to clipboard

The content description for the video container. Of type String.

Link copied to clipboard

Represents the parameters of the full-screen button.

Link copied to clipboard

The state of the video player, whether it is playing or not. Of type MutableState of Boolean.

Link copied to clipboard
val onBackgroundPress: () -> Unit? = null

Optional onClick callback for the background press event. Can be used for a custom event, if null then the background will act as the play / pause button.

Link copied to clipboard

Represents the parameters of the play / pause button.

Link copied to clipboard
val player: @Composable () -> Unit

The composable lambda that will be used to draw the video player.

Link copied to clipboard

Represents the parameters of the transcription button.