android-ui-tv/com.theoplayer.android.ui.tv

Package-level declarations

Types

@RequiresOptIn(message = "This TV UI API is experimental and may change in future releases.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class ExperimentalTvUiApi

Marks declarations that are part of the experimental THEOplayer Android TV UI API.

SliderColors

@Immutable

class SliderColors(val thumbColor: Color, val activeTrackColor: Color, val inactiveTrackColor: Color, val disabledThumbColor: Color, val disabledActiveTrackColor: Color, val disabledInactiveTrackColor: Color)

Colors used to draw a TV slider in enabled and disabled states.

SliderDefaults

object SliderDefaults

Creates slider colors and default slider content.

SliderState

@Stable

class SliderState(value: Float = 0.0f, valueRange: ClosedFloatingPointRange<Float> = 0f..1f)

Holds the value and range for a TV slider.

Functions

AudioTrackList

@Composable

fun AudioTrackList(modifier: Modifier = Modifier, onClick: () -> Unit? = null)

@Composable

fun AudioTrackList(state: AudioTrackState, modifier: Modifier = Modifier, onClick: () -> Unit? = null)

A list of audio tracks, from which the user can choose an active audio track.

AudioTrackMenu

@Composable

fun MenuScope.AudioTrackMenu()

@Composable

fun MenuScope.AudioTrackMenu(state: AudioTrackState)

A menu to change the spoken language of the stream.

CurrentTimeDisplay

@Composable

fun CurrentTimeDisplay(modifier: Modifier = Modifier, showRemaining: Boolean = false, showDuration: Boolean = false)

@Composable

fun CurrentTimeDisplay(state: PlaybackTimeState, modifier: Modifier = Modifier, showRemaining: Boolean = false, showDuration: Boolean = false)

A text display that shows the player's current time.

DefaultUI

@Composable

fun DefaultUI(modifier: Modifier = Modifier, theoplayerView: THEOplayerView, title: String? = null)

@Composable

fun DefaultUI(modifier: Modifier = Modifier, config: THEOplayerConfig, source: SourceDescription? = null, title: String? = null)

A default THEOplayer UI component for Android TV.

DurationDisplay

@Composable

fun DurationDisplay(modifier: Modifier = Modifier)

@Composable

fun DurationDisplay(state: PlaybackTimeState, modifier: Modifier = Modifier)

A text display that shows the player's duration.

ErrorDisplay

@Composable

fun ErrorDisplay(modifier: Modifier = Modifier)

@Composable

fun ErrorDisplay(state: ErrorState, modifier: Modifier = Modifier)

A display for a fatal error, if the player encounters one.

LanguageMenu

@Composable

fun MenuScope.LanguageMenu()

@Composable

fun MenuScope.LanguageMenu(audioTrackState: AudioTrackState, subtitleTrackState: SubtitleTrackState)

A menu to change the spoken language and subtitles of the stream.

LanguageMenuButton

@Composable

fun MenuScope.LanguageMenuButton(modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable () -> Unit = { Icon( painter = painterResource(id = CommonR.drawable.language), contentDescription = stringResource(CommonR.string.theoplayer_ui_menu_language), ) })

@Composable

fun MenuScope.LanguageMenuButton(audioTrackState: AudioTrackState, subtitleTrackState: SubtitleTrackState, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable () -> Unit = { Icon( painter = painterResource(id = CommonR.drawable.language), contentDescription = stringResource(CommonR.string.theoplayer_ui_menu_language), ) })

A button that opens the language menu.

LiveButton

@Composable

fun LiveButton(modifier: Modifier = Modifier, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, colors: ButtonColors = ButtonDefaults.colors(), liveThreshold: Double = 10.0, live: @Composable RowScope.() -> Unit = { LiveButtonContent(LocalPlayerColors.current.liveButtonLive) }, dvr: @Composable RowScope.() -> Unit = { LiveButtonContent(LocalPlayerColors.current.liveButtonDvr) })

@Composable

fun LiveButton(state: LiveButtonState, modifier: Modifier = Modifier, contentPadding: PaddingValues = ButtonDefaults.ContentPadding, colors: ButtonColors = ButtonDefaults.colors(), live: @Composable RowScope.() -> Unit = { LiveButtonContent(LocalPlayerColors.current.liveButtonLive) }, dvr: @Composable RowScope.() -> Unit = { LiveButtonContent(LocalPlayerColors.current.liveButtonDvr) })

A button that shows whether the player is currently playing at the live point, and seeks to the live point when clicked.

LoadingSpinner

@Composable

fun LoadingSpinner(modifier: Modifier = Modifier, color: Color = MaterialTheme.colorScheme.primary, strokeWidth: Dp = 4.dp, delay: Duration = LocalPlayerAnimations.current.loadingSpinnerDelay)

@Composable

fun LoadingSpinner(state: LoadingState, modifier: Modifier = Modifier, color: Color = MaterialTheme.colorScheme.primary, strokeWidth: Dp = 4.dp, delay: Duration = LocalPlayerAnimations.current.loadingSpinnerDelay)

An indicator that shows whether the player is currently waiting for more data to resume playback.

@Composable

fun MenuScope.Menu(modifier: Modifier = Modifier, title: @Composable () -> Unit, content: @Composable ColumnScope.() -> Unit)

A side menu displayed at the end edge of the player.

PlaybackRateList

@Composable

fun PlaybackRateList(modifier: Modifier = Modifier, playbackRates: List<Double> = defaultPlaybackRates, onClick: () -> Unit? = null)

@Composable

fun PlaybackRateList(state: PlaybackRateState, modifier: Modifier = Modifier, playbackRates: List<Double> = defaultPlaybackRates, onClick: () -> Unit? = null)

A list of playback rates, from which the user can choose a desired playback rate.

PlaybackRateMenu

@Composable

fun MenuScope.PlaybackRateMenu()

@Composable

fun MenuScope.PlaybackRateMenu(state: PlaybackRateState)

A menu to change the playback rate of the player.

PlayButton

@Composable

fun PlayButton(modifier: Modifier = Modifier, iconModifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), play: @Composable () -> Unit = { Icon( painter = painterResource(R.drawable.play), modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_play), ) }, pause: @Composable () -> Unit = { Icon( painter = painterResource(R.drawable.pause), modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_pause), ) }, replay: @Composable () -> Unit = { Icon( Icons.Rounded.Replay, modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_replay), ) })

@Composable

fun PlayButton(state: PlayButtonState, modifier: Modifier = Modifier, iconModifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), play: @Composable () -> Unit = { Icon( painter = painterResource(R.drawable.play), modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_play), ) }, pause: @Composable () -> Unit = { Icon( painter = painterResource(R.drawable.pause), modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_pause), ) }, replay: @Composable () -> Unit = { Icon( Icons.Rounded.Replay, modifier = iconModifier, contentDescription = stringResource(R.string.theoplayer_ui_btn_replay), ) })

A button that toggles whether the player is playing or paused.

QualityList

@Composable

fun QualityList(modifier: Modifier = Modifier, onClick: () -> Unit? = null)

@Composable

fun QualityList(state: VideoQualityState, modifier: Modifier = Modifier, onClick: () -> Unit? = null)

A list of video qualities, from which the user can choose a target video quality.

QualityMenu

@Composable

fun MenuScope.QualityMenu()

@Composable

fun MenuScope.QualityMenu(state: VideoQualityState)

A menu to change the video quality of the stream.

SeekBar

@Composable

fun SeekBar(modifier: Modifier = Modifier, colors: SliderColors = SliderDefaults.colors(), seekOffset: Int = 10)

A seek bar showing the player's current time and allowing D-pad seeking.

@Composable

fun SeekBar(state: SeekBarState, modifier: Modifier = Modifier, colors: SliderColors = SliderDefaults.colors(), seekOffset: Int = 10)

A seek bar showing the current time from state and allowing D-pad seeking.

SeekButton

@Composable

fun SeekButton(modifier: Modifier = Modifier, seekOffset: Int = 10, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable () -> Unit)

@Composable

fun SeekButton(modifier: Modifier = Modifier, seekOffset: Int = 10, iconSize: Dp = 24.dp, contentPadding: PaddingValues = PaddingValues(0.dp))

@Composable

fun SeekButton(state: SeekButtonState, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable () -> Unit)

A button that seeks forward or backward by a fixed offset.

SettingsMenu

@Composable

fun MenuScope.SettingsMenu()

@Composable

fun MenuScope.SettingsMenu(videoQualityState: VideoQualityState, playbackRateState: PlaybackRateState)

A menu to change the settings of the player, such as video quality or playback rate.

SettingsMenuButton

@Composable

fun MenuScope.SettingsMenuButton(modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable () -> Unit = { Icon( Icons.Rounded.Settings, contentDescription = stringResource(CommonR.string.theoplayer_ui_menu_settings), ) })

A button that opens the settings menu.

Slider

@Composable

fun Slider(state: SliderState, onValueChange: (Float) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, keyStep: Float = (state.valueRange.endInclusive - state.valueRange.start) / 100f, keyRepeatStep: Float = keyStep, onValueChangeFinished: () -> Unit? = null, colors: SliderColors = SliderDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, thumb: @Composable (SliderState) -> Unit = { SliderDefaults.Thumb( interactionSource = interactionSource, colors = colors, enabled = enabled, ) }, track: @Composable (SliderState) -> Unit = { sliderState -> SliderDefaults.Track(sliderState = sliderState, colors = colors, enabled = enabled) })

Displays a slider backed by state and controlled by D-pad keys.

@Composable

fun Slider(value: Float, onValueChange: (Float) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, valueRange: ClosedFloatingPointRange<Float> = 0f..1f, keyStep: Float = (valueRange.endInclusive - valueRange.start) / 100f, keyRepeatStep: Float = keyStep, onValueChangeFinished: () -> Unit? = null, colors: SliderColors = SliderDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() }, thumb: @Composable (SliderState) -> Unit = { SliderDefaults.Thumb( interactionSource = interactionSource, colors = colors, enabled = enabled, ) }, track: @Composable (SliderState) -> Unit = { sliderState -> SliderDefaults.Track(sliderState = sliderState, colors = colors, enabled = enabled) })

Displays a focusable slider controlled by D-pad keys.

SubtitleMenu

@Composable

fun MenuScope.SubtitleMenu()

@Composable

fun MenuScope.SubtitleMenu(state: SubtitleTrackState)

A menu to change the subtitles of the stream.

SubtitleTrackList

@Composable

fun SubtitleTrackList(modifier: Modifier = Modifier, onClick: () -> Unit? = null)

@Composable

fun SubtitleTrackList(state: SubtitleTrackState, modifier: Modifier = Modifier, onClick: () -> Unit? = null)

A list of subtitle tracks, from which the user can choose an active subtitle track.

TextTrackStyleMenu

@Composable

fun MenuScope.TextTrackStyleMenu()

@Composable

fun MenuScope.TextTrackStyleMenu(state: TextTrackStyleState)

A menu to change the style of the subtitles, such as the font family, the font color or the background color.

UIController

@Composable

fun UIController(modifier: Modifier = Modifier, theoplayerView: THEOplayerView, color: Color = Color.Black.copy(alpha = 0.5f), centerOverlay: @Composable UIControllerScope.() -> Unit? = null, errorOverlay: @Composable UIControllerScope.() -> Unit? = null, topChrome: @Composable UIControllerScope.() -> Unit? = null, centerChrome: @Composable UIControllerScope.() -> Unit? = null, bottomChrome: @Composable UIControllerScope.() -> Unit? = null)

@Composable

fun UIController(modifier: Modifier = Modifier, config: THEOplayerConfig, source: SourceDescription? = null, color: Color = Color.Black.copy(alpha = 0.5f), centerOverlay: @Composable UIControllerScope.() -> Unit? = null, errorOverlay: @Composable UIControllerScope.() -> Unit? = null, topChrome: @Composable UIControllerScope.() -> Unit? = null, centerChrome: @Composable UIControllerScope.() -> Unit? = null, bottomChrome: @Composable UIControllerScope.() -> Unit? = null)

A TV-oriented UI controller for a THEOplayer view.