Skip to content

TtmlDestinationSettings

Source code in docs_src/capo_mediaconvert/types/ttml_destination_settings.py
class TtmlDestinationSettings(TypedDict, closed=True):
    background_color: NotRequired[
        "capo_mediaconvert.types.ttml_background_color.TtmlBackgroundColor"
    ]
    """Specify the color of the rectangle behind the captions. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the background color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default black."""
    background_opacity: NotRequired[
        "capo_mediaconvert.types.__integer_min0_max255.__integerMin0Max255"
    ]
    """Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled and backgroundColor is set, leave blank to use a value of 255 (opaque)."""
    font_color: NotRequired["capo_mediaconvert.types.ttml_font_color.TtmlFontColor"]
    """Specify the color of the captions text. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the font color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default white."""
    font_opacity: NotRequired[
        "capo_mediaconvert.types.__integer_min0_max255.__integerMin0Max255"
    ]
    """Specify the opacity of the captions. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the font opacity information in your input captions to your output captions. If Style passthrough is set to disabled and fontColor is set, leave blank to use a value of 255 (opaque)."""
    font_size: NotRequired[
        "capo_mediaconvert.types.__integer_min0_max96.__integerMin0Max96"
    ]
    """Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size."""
    font_style: NotRequired["capo_mediaconvert.types.ttml_font_style.TtmlFontStyle"]
    """Specify the font style of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font style from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal style."""
    font_weight: NotRequired["capo_mediaconvert.types.ttml_font_weight.TtmlFontWeight"]
    """Specify the font weight of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font weight from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal weight."""
    style_passthrough: NotRequired[
        "capo_mediaconvert.types.ttml_style_passthrough.TtmlStylePassthrough"
    ]
    """Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output."""
    text_decoration: NotRequired[
        "capo_mediaconvert.types.ttml_text_decoration.TtmlTextDecoration"
    ]
    """Specify the text decoration of the caption text. If Style passthrough is set to enabled, leave blank to pass through the text decoration from your input captions. If Style passthrough is set to disabled, leave blank to use the default of none."""

background_color instance-attribute

background_color: NotRequired[TtmlBackgroundColor]

Specify the color of the rectangle behind the captions. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the background color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default black.

background_opacity instance-attribute

background_opacity: NotRequired[__integerMin0Max255]

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled and backgroundColor is set, leave blank to use a value of 255 (opaque).

font_color instance-attribute

font_color: NotRequired[TtmlFontColor]

Specify the color of the captions text. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the font color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default white.

font_opacity instance-attribute

font_opacity: NotRequired[__integerMin0Max255]

Specify the opacity of the captions. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the font opacity information in your input captions to your output captions. If Style passthrough is set to disabled and fontColor is set, leave blank to use a value of 255 (opaque).

font_size instance-attribute

font_size: NotRequired[__integerMin0Max96]

Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

font_style instance-attribute

font_style: NotRequired[TtmlFontStyle]

Specify the font style of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font style from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal style.

font_weight instance-attribute

font_weight: NotRequired[TtmlFontWeight]

Specify the font weight of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font weight from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal weight.

style_passthrough instance-attribute

style_passthrough: NotRequired[TtmlStylePassthrough]

Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output.

text_decoration instance-attribute

text_decoration: NotRequired[TtmlTextDecoration]

Specify the text decoration of the caption text. If Style passthrough is set to enabled, leave blank to pass through the text decoration from your input captions. If Style passthrough is set to disabled, leave blank to use the default of none.