Package software.amazon.awssdk.services.medialive.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EbuTtDDestinationSettings.Builder

Method Summary

Modifier and Type	Method	Description
static EbuTtDDestinationSettings.Builder	builder()
String	copyrightHolder()	Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EbuTtDFillLineGapControl	fillLineGap()	Specifies how to handle the gap between the lines (in multi-line captions).
String	fillLineGapAsString()	Specifies how to handle the gap between the lines (in multi-line captions).
String	fontFamily()	Specifies the font family to include in the font data attached to the EBU-TT captions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EbuTtDDestinationSettings.Builder>	serializableBuilderClass()
EbuTtDDestinationStyleControl	styleControl()	Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.
String	styleControlAsString()	Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.
EbuTtDDestinationSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

EbuTtDFillLineGapControl

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:

EbuTtDFillLineGapControl

fontFamily

public final String fontFamily()

Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You 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. - 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). - Leave blank to set the family to “monospace”.

Returns:

Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You 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. - 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). - Leave blank to set the family to “monospace”.

styleControl

public final EbuTtDDestinationStyleControl styleControl()

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) 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: In the font data attached to the EBU-TT captions, 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 (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) 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: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.

See Also:

EbuTtDDestinationStyleControl

styleControlAsString

public final String styleControlAsString()

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) 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: In the font data attached to the EBU-TT captions, 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 (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) 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: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.

See Also:

EbuTtDDestinationStyleControl

toBuilder

public EbuTtDDestinationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EbuTtDDestinationSettings.Builder,EbuTtDDestinationSettings>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo