mediaconvert/aws.sdk.kotlin.services.mediaconvert.model/TtmlDestinationSettings

TtmlDestinationSettings

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.

Types

Builder

class Builder

Companion

object Companion

Properties

backgroundColor

val backgroundColor: 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.

backgroundOpacity

val backgroundOpacity: Int?

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).

fontColor

val fontColor: 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.

fontOpacity

val fontOpacity: Int?

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).

fontSize

val fontSize: Int?

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

fontStyle

val fontStyle: 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.

fontWeight

val fontWeight: 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.

stylePassthrough

val stylePassthrough: TtmlStylePassthrough?

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

textDecoration

val textDecoration: 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.

Functions

copy

inline fun copy(block: TtmlDestinationSettings.Builder.() -> Unit = {}): TtmlDestinationSettings

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String