@RequiresOptIn(message = "This API is internal to the THEOplayer Open Video UI for Android and may change at any time.", level = RequiresOptIn.Level.ERROR)

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

annotation class InternalUiApi

Marks declarations that are internal to the THEOplayer Open Video UI for Android.

LiveButtonState

class LiveButtonState

State holder for a "live" button, such as LiveButton.

LoadingState

class LoadingState

State holder for a loading indicator, such as LoadingSpinner.

MenuContent

typealias MenuContent = @Composable MenuScope.() -> Unit

The content for a new menu, typically this should draw a single Menu.

MenuScope

@SubclassOptInRequired(markerClass = [InternalUiApi::class])

interface MenuScope

Scope for the contents of a Menu.

MuteButtonState

class MuteButtonState

State holder for a mute button, such as MuteButton.

PictureInPictureState

class PictureInPictureState

State holder for a picture-in-picture button, such as PictureInPictureButton.

PlaybackRateState

class PlaybackRateState

State holder for the playback rate, such as PlaybackRateList or PlaybackRateMenu.

PlaybackTimeState

open class PlaybackTimeState

State holder for a playback time display, such as CurrentTimeDisplay or DurationDisplay.

PlayButtonState

class PlayButtonState

State holder for a play/pause button, such as PlayButton.

Player

interface Player

A player holding a THEOplayer instance that can be hosted by a DefaultUI or UIController.

SeekBarState

class SeekBarState : PlaybackTimeState

State holder for a seek bar, such as SeekBar.

SeekButtonState

class SeekButtonState

State holder for a button that seeks forward or backward by a fixed offset, such as SeekButton.

StreamType

enum class StreamType : Enum<StreamType>

The type of a stream.

SubtitleTrackState

class SubtitleTrackState

State holder for subtitle tracks, such as SubtitleTrackList or SubtitleMenu.

TextTrackFontFamily

enum class TextTrackFontFamily : Enum<TextTrackFontFamily>

A font family that can be selected in a text track style menu, such as TextTrackStyleMenu.

TextTrackStyleState

class TextTrackStyleState

State holder for the style of subtitles, such as TextTrackStyleMenu.

TimeRanges

data class TimeRanges(ranges: List<ClosedFloatingPointRange<Double>>) : List<ClosedFloatingPointRange<Double>>

Represents one or more ranges of time, each specified by a start time and an end time.

UIControllerScope

@SubclassOptInRequired(markerClass = [InternalUiApi::class])

interface UIControllerScope : MenuScope

Scope for the contents of a UIController.

VideoQualityState

class VideoQualityState

State holder for video qualities, such as QualityList or QualityMenu.

VideoSizeState

class VideoSizeState

State holder for the video dimensions.

Properties

LocalTHEOplayerView

val LocalTHEOplayerView: ProvidableCompositionLocal<THEOplayerView?>

The THEOplayerView controlled by the enclosing UIController.

Functions

rememberAdState

@Composable

fun rememberAdState(player: Player?): AdState

Creates an AdState that's remembered across compositions.

rememberAudioTrackState

@Composable

fun rememberAudioTrackState(player: Player?): AudioTrackState

Creates an AudioTrackState that's remembered across compositions.

rememberCastState

@Composable

fun rememberCastState(theoplayerView: THEOplayerView?): CastState

Creates a CastState that's remembered across compositions.

rememberErrorState

@Composable

fun rememberErrorState(player: Player?): ErrorState

Creates an ErrorState that's remembered across compositions.

rememberFirstPlayState

@Composable

fun rememberFirstPlayState(player: Player?): FirstPlayState

Creates a FirstPlayState that's remembered across compositions.

rememberFullscreenState

@Composable

fun rememberFullscreenState(theoplayerView: THEOplayerView?): FullscreenState

Creates a FullscreenState that's remembered across compositions.

rememberLiveButtonState

@Composable

fun rememberLiveButtonState(player: Player?, liveThreshold: Double): LiveButtonState

Creates a LiveButtonState that's remembered across compositions.

rememberLoadingState

@Composable

fun rememberLoadingState(player: Player?): LoadingState

Creates a LoadingState that's remembered across compositions.

rememberMuteButtonState

@Composable

fun rememberMuteButtonState(player: Player?): MuteButtonState

Creates a MuteButtonState that's remembered across compositions.

rememberPictureInPictureState

@Composable

fun rememberPictureInPictureState(theoplayerView: THEOplayerView?): PictureInPictureState

Creates a PictureInPictureState that's remembered across compositions.

rememberPlaybackRateState

@Composable

fun rememberPlaybackRateState(player: Player?): PlaybackRateState

Creates a PlaybackRateState that's remembered across compositions.

rememberPlaybackTimeState

@Composable

fun rememberPlaybackTimeState(player: Player?): PlaybackTimeState

Creates a PlaybackTimeState that's remembered across compositions.

rememberPlayButtonState

@Composable

fun rememberPlayButtonState(player: Player?): PlayButtonState

Creates a PlayButtonState that's remembered across compositions.

rememberSeekBarState

@Composable

fun rememberSeekBarState(player: Player?): SeekBarState

Creates a SeekBarState that's remembered across compositions.

rememberSeekButtonState

@Composable

fun rememberSeekButtonState(player: Player?, seekOffset: Int): SeekButtonState

Creates a SeekButtonState that's remembered across compositions.

rememberSubtitleTrackState

@Composable

fun rememberSubtitleTrackState(player: Player?): SubtitleTrackState

Creates a SubtitleTrackState that's remembered across compositions.

rememberTextTrackStyleState

@Composable

fun rememberTextTrackStyleState(player: Player?): TextTrackStyleState

Creates a TextTrackStyleState that's remembered across compositions.

rememberTHEOplayerView

@Composable

fun rememberTHEOplayerView(config: THEOplayerConfig? = null): THEOplayerView

Creates and remembers a THEOplayerView owned by the composition.

rememberVideoQualityState

@Composable

fun rememberVideoQualityState(player: Player?): VideoQualityState

Creates a VideoQualityState that's remembered across compositions.

rememberVideoSizeState

@Composable

fun rememberVideoSizeState(player: Player?): VideoSizeState

Creates a VideoSizeState that's remembered across compositions.