MediaItem.SubtitleConfiguration.Builder

Artifact: androidx.media3:media3-common

View Source

---

Kotlin |Java

class MediaItem.SubtitleConfiguration.Builder

---

Builder for SubtitleConfiguration instances.

Summary

Public constructors
Builder(uri: Uri!) Constructs an instance.

Public functions
MediaItem.SubtitleConfiguration!	build() Creates a SubtitleConfiguration from the values of this builder.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setId(id: String?) Sets the optional ID for this subtitle track.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setLabel(label: String?) Sets the optional label for this subtitle track.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setLanguage(language: String?) Sets the optional language of the subtitle file.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setMimeType(mimeType: String?) Sets the MIME type.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setRoleFlags(@C.RoleFlags roleFlags: Int) Sets the role flags.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setSelectionFlags(@C.SelectionFlags selectionFlags: Int) Sets the flags used for track selection.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue @UnstableApi setTimeOffsetUs(timeOffsetUs: Long) Sets the offset that is added to the timestamps of the cues in this subtitle track, in microseconds.
MediaItem.SubtitleConfiguration.Builder!	@CanIgnoreReturnValue setUri(uri: Uri!) Sets the Uri to the subtitle file.

Public constructors

Builder

Builder(uri: Uri!)

Constructs an instance.

Parameters
uri: Uri!	The Uri to the subtitle file.

Public functions

build

fun build(): MediaItem.SubtitleConfiguration!

Creates a SubtitleConfiguration from the values of this builder.

setId

@CanIgnoreReturnValue
fun setId(id: String?): MediaItem.SubtitleConfiguration.Builder!

Sets the optional ID for this subtitle track.

setLabel

@CanIgnoreReturnValue
fun setLabel(label: String?): MediaItem.SubtitleConfiguration.Builder!

Sets the optional label for this subtitle track.

setLanguage

@CanIgnoreReturnValue
fun setLanguage(language: String?): MediaItem.SubtitleConfiguration.Builder!

Sets the optional language of the subtitle file.

setMimeType

@CanIgnoreReturnValue
fun setMimeType(mimeType: String?): MediaItem.SubtitleConfiguration.Builder!

Sets the MIME type.

setRoleFlags

@CanIgnoreReturnValue
fun setRoleFlags(@C.RoleFlags roleFlags: Int): MediaItem.SubtitleConfiguration.Builder!

Sets the role flags. These are used for track selection.

setSelectionFlags

@CanIgnoreReturnValue
fun setSelectionFlags(@C.SelectionFlags selectionFlags: Int): MediaItem.SubtitleConfiguration.Builder!

Sets the flags used for track selection.

setTimeOffsetUs

@CanIgnoreReturnValue
@UnstableApi
fun setTimeOffsetUs(timeOffsetUs: Long): MediaItem.SubtitleConfiguration.Builder!

Sets the offset that is added to the timestamps of the cues in this subtitle track, in microseconds.

A positive value shifts the cues to be displayed later relative to the media, a negative value shifts them to be displayed earlier.

ExoPlayer specific notes:

• The offset can be changed during playback by passing an updated MediaItem to Player.replaceMediaItem(int, MediaItem). If only the time offsets of the SubtitleConfiguration instances are changed, playback continues uninterrupted and the new offsets apply to cues that have not been read by the renderer yet. To also apply the new offset to the cues currently on screen, disable and re-enable the text track, for example with TrackSelectionParameters.Builder.setTrackTypeDisabled(C.TRACK_TYPE_TEXT, boolean).
• The offset only takes effect if the subtitles are parsed during extraction (the default behavior of DefaultMediaSourceFactory), and is ignored by the deprecated legacy subtitle decoding path.

The default value is 0.

setUri

@CanIgnoreReturnValue
fun setUri(uri: Uri!): MediaItem.SubtitleConfiguration.Builder!

Sets the Uri to the subtitle file.