Class EbuTtDDestinationSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.EbuTtDDestinationSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EbuTtDDestinationSettings.Builder,EbuTtDDestinationSettings>
@Generated("software.amazon.awssdk:codegen") public final class EbuTtDDestinationSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EbuTtDDestinationSettings.Builder,EbuTtDDestinationSettings>
Ebu Tt DDestination Settings
See Also:

  • Method Details

    • copyrightHolder

      public final String copyrightHolder()
      Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.
      Returns:
      Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.

    • fillLineGap

      public final EbuTtDFillLineGapControl fillLineGap()
      Specifies how to handle the gap between the lines (in multi-line captions). ENABLED: Fill with the captions background color (as specified in the input captions). DISABLED: Leave the gap unfilled

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

      Returns:
      Specifies how to handle the gap between the lines (in multi-line captions). ENABLED: Fill with the captions background color (as specified in the input captions). DISABLED: Leave the gap unfilled
      See Also:

    • fillLineGapAsString

      public final String fillLineGapAsString()
      Specifies how to handle the gap between the lines (in multi-line captions). ENABLED: Fill with the captions background color (as specified in the input captions). DISABLED: Leave the gap unfilled

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

      Returns:
      Specifies how to handle the gap between the lines (in multi-line captions). ENABLED: Fill with the captions background color (as specified in the input captions). DISABLED: Leave the gap unfilled
      See Also:

    • fontFamily

      public final String fontFamily()
      Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if style_control is set to include. (If style_control is set to exclude, the font family is always set to monospaced.) Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as Arial), or a generic font family (such as serif), or default (to let the downstream player choose the font). Or leave blank to set the family to monospace. Note that you can specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.
      Returns:
      Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if style_control is set to include. (If style_control is set to exclude, the font family is always set to monospaced.) Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as Arial), or a generic font family (such as serif), or default (to let the downstream player choose the font). Or leave blank to set the family to monospace. Note that you can specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.

    • styleControl

      public final EbuTtDDestinationStyleControl styleControl()
      Specifies the style information to include in the font data that is attached to the EBU-TT captions. INCLUDE: Take the style information from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. EXCLUDE: Set the font family to monospaced. Do not include any other style information.

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

      Returns:
      Specifies the style information to include in the font data that is attached to the EBU-TT captions. INCLUDE: Take the style information from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. EXCLUDE: Set the font family to monospaced. Do not include any other style information.
      See Also:

    • styleControlAsString

      public final String styleControlAsString()
      Specifies the style information to include in the font data that is attached to the EBU-TT captions. INCLUDE: Take the style information from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. EXCLUDE: Set the font family to monospaced. Do not include any other style information.

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

      Returns:
      Specifies the style information to include in the font data that is attached to the EBU-TT captions. INCLUDE: Take the style information from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. EXCLUDE: Set the font family to monospaced. Do not include any other style information.
      See Also:

    • defaultFontSize

      public final Integer defaultFontSize()
      Specifies the default font size as a percentage of the computed cell size. Valid only if the defaultLineHeight is also set. If you leave this field empty, the default font size is 80% of the cell size.
      Returns:
      Specifies the default font size as a percentage of the computed cell size. Valid only if the defaultLineHeight is also set. If you leave this field empty, the default font size is 80% of the cell size.

    • defaultLineHeight

      public final Integer defaultLineHeight()
      Documentation update needed
      Returns:
      Documentation update needed

    • toBuilder

      public EbuTtDDestinationSettings.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<EbuTtDDestinationSettings.Builder,EbuTtDDestinationSettings>
      Returns:
      a builder for type T

    • builder

      public static EbuTtDDestinationSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EbuTtDDestinationSettings.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.