android-ui-common/com.theoplayer.android.ui/SubtitleTrackState

SubtitleTrackState

class SubtitleTrackState(source)

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

Create an instance with rememberSubtitleTrackState.

Properties

activeSubtitleTrack

var activeSubtitleTrack: TextTrack?

The currently shown subtitle track, if any.

subtitleTracks

var subtitleTracks: List<TextTrack>

The available subtitle tracks.

Functions

select

fun select(track: TextTrack?)

Selects the subtitle track to show, or null to hide all subtitles. All other subtitle tracks are disabled; non-subtitle text tracks are not touched.