kiteplayer-core/io.github.yuroyami.kiteplayer/SubtitleConfigBuilder

SubtitleConfigBuilder

class SubtitleConfigBuilder(from: SubtitleConfig = SubtitleConfig())

The fields of a SubtitleConfig, set in a subtitles { } block. Each one is the field of that name.

Constructors

SubtitleConfigBuilder

constructor(from: SubtitleConfig = SubtitleConfig())

Properties

assColorMatching

var assColorMatching: Boolean

See SubtitleConfig.assColorMatching.

var autoSelect: Boolean

See SubtitleConfig.autoSelect.

autoSelectForced

var autoSelectForced: Boolean

See SubtitleConfig.autoSelectForced.

var delay: Duration

See SubtitleConfig.delay.

fallbackEncoding

var fallbackEncoding: String?

See SubtitleConfig.fallbackEncoding.

var fonts: List<SubtitleFont>

See SubtitleConfig.fonts.

var fontScale: Float

See SubtitleConfig.fontScale.

forcedPicturesOnly

var forcedPicturesOnly: Boolean

See SubtitleConfig.forcedPicturesOnly.

forcedPicturesWhenOff

var forcedPicturesWhenOff: Boolean

See SubtitleConfig.forcedPicturesWhenOff.

hearingImpairedNotes

var hearingImpairedNotes: HearingImpairedNotes

See SubtitleConfig.hearingImpairedNotes.

preferredLanguages

var preferredLanguages: List<String>

See SubtitleConfig.preferredLanguages.

secondaryLanguages

var secondaryLanguages: List<String>

See SubtitleConfig.secondaryLanguages.

secondaryPlacement

var secondaryPlacement: SecondarySubtitlePlacement

See SubtitleConfig.secondaryPlacement.

var style: SubtitleStyleOverride?

See SubtitleConfig.style.

var typesetting: Boolean

See SubtitleConfig.typesetting.

withMatchingAudio

var withMatchingAudio: MatchingAudioSubtitles

See SubtitleConfig.withMatchingAudio.

Functions

fun build(): SubtitleConfig

The SubtitleConfig these fields describe, checked as its constructor checks it.