Skip to main content

VideoSubtitleConfiguration

Represents the configuration for video subtitles.

Properties

  • padding - The padding to be used for the subtitles.
  • text_align - The text alignment to be used for the subtitles.
  • text_scale_factor - Defines the scale factor for the subtitle text.
  • text_style - The text style to be used for the subtitles.
  • visible - Whether the subtitles should be visible or not.

Properties​

paddingclass-attributeinstance-attribute​

padding: PaddingValue = field(
    default_factory=lambda: Padding(
        left=16.0, top=0.0, right=16.0, bottom=24.0
    )
)

The padding to be used for the subtitles.

text_alignclass-attributeinstance-attribute​

text_align: TextAlign = TextAlign.CENTER

The text alignment to be used for the subtitles.

text_scale_factorclass-attributeinstance-attribute​

text_scale_factor: Number = 1.0

Defines the scale factor for the subtitle text.

text_styleclass-attributeinstance-attribute​

text_style: TextStyle = field(
    default_factory=lambda: TextStyle(
        height=1.4,
        size=32.0,
        letter_spacing=0.0,
        word_spacing=0.0,
        color=Colors.WHITE,
        weight=FontWeight.NORMAL,
        bgcolor=Colors.BLACK_54,
    )
)

The text style to be used for the subtitles.

visibleclass-attributeinstance-attribute​

visible: bool = True

Whether the subtitles should be visible or not.