Class TtmlDestinationSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.TtmlDestinationSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TtmlDestinationSettings.Builder,TtmlDestinationSettings>
@Generated("software.amazon.awssdk:codegen") public final class TtmlDestinationSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TtmlDestinationSettings.Builder,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.
See Also:

  • Method Details

    • backgroundColor

      public final TtmlBackgroundColor backgroundColor()
      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.

      If the service returns an enum value that is not available in the current SDK version, backgroundColor will return TtmlBackgroundColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundColorAsString().

      Returns:
      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.
      See Also:

    • backgroundColorAsString

      public final String backgroundColorAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, backgroundColor will return TtmlBackgroundColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundColorAsString().

      Returns:
      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.
      See Also:

    • backgroundOpacity

      public final Integer backgroundOpacity()
      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).
      Returns:
      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

      public final TtmlFontColor fontColor()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontColor will return TtmlFontColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontColorAsString().

      Returns:
      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.
      See Also:

    • fontColorAsString

      public final String fontColorAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontColor will return TtmlFontColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontColorAsString().

      Returns:
      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.
      See Also:

    • fontOpacity

      public final Integer fontOpacity()
      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).
      Returns:
      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

      public final Integer fontSize()
      Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.
      Returns:
      Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

    • fontStyle

      public final TtmlFontStyle fontStyle()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontStyle will return TtmlFontStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontStyleAsString().

      Returns:
      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.
      See Also:

    • fontStyleAsString

      public final String fontStyleAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontStyle will return TtmlFontStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontStyleAsString().

      Returns:
      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.
      See Also:

    • fontWeight

      public final TtmlFontWeight fontWeight()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontWeight will return TtmlFontWeight.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontWeightAsString().

      Returns:
      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.
      See Also:

    • fontWeightAsString

      public final String fontWeightAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, fontWeight will return TtmlFontWeight.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontWeightAsString().

      Returns:
      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.
      See Also:

    • stylePassthrough

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

      If the service returns an enum value that is not available in the current SDK version, stylePassthrough will return TtmlStylePassthrough.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stylePassthroughAsString().

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

    • stylePassthroughAsString

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

      If the service returns an enum value that is not available in the current SDK version, stylePassthrough will return TtmlStylePassthrough.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stylePassthroughAsString().

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

    • textDecoration

      public final TtmlTextDecoration textDecoration()
      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.

      If the service returns an enum value that is not available in the current SDK version, textDecoration will return TtmlTextDecoration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textDecorationAsString().

      Returns:
      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.
      See Also:

    • textDecorationAsString

      public final String textDecorationAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, textDecoration will return TtmlTextDecoration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textDecorationAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public TtmlDestinationSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TtmlDestinationSettings.Builder,TtmlDestinationSettings>
      Returns:
      a builder for type T

    • builder

      public static TtmlDestinationSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TtmlDestinationSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.