software.amazon.awssdk.services.mediaconvert.model

Class BurninDestinationSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.BurninDestinationSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class BurninDestinationSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>

Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BurninDestinationSettings.Builder

Method Summary

Modifier and Type	Method and Description
BurninSubtitleAlignment	alignment() If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output.
String	alignmentAsString() If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output.
BurninSubtitleBackgroundColor	backgroundColor() Specifies the color of the rectangle behind the captions.
String	backgroundColorAsString() Specifies the color of the rectangle behind the captions.
Integer	backgroundOpacity() Specifies the opacity of the background rectangle.
static BurninDestinationSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
BurninSubtitleFontColor	fontColor() Specifies the color of the burned-in captions.
String	fontColorAsString() Specifies the color of the burned-in captions.
Integer	fontOpacity() Specifies the opacity of the burned-in captions.
Integer	fontResolution() Font resolution in DPI (dots per inch); default is 96 dpi.
FontScript	fontScript() Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type.
String	fontScriptAsString() Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type.
Integer	fontSize() A positive integer indicates the exact font size in points.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
BurninSubtitleOutlineColor	outlineColor() Specifies font outline color.
String	outlineColorAsString() Specifies font outline color.
Integer	outlineSize() Specifies font outline size in pixels.
List<SdkField<?>>	sdkFields()
static Class<? extends BurninDestinationSettings.Builder>	serializableBuilderClass()
BurninSubtitleShadowColor	shadowColor() Specifies the color of the shadow cast by the captions.
String	shadowColorAsString() Specifies the color of the shadow cast by the captions.
Integer	shadowOpacity() Specifies the opacity of the shadow.
Integer	shadowXOffset() Specifies the horizontal offset of the shadow relative to the captions in pixels.
Integer	shadowYOffset() Specifies the vertical offset of the shadow relative to the captions in pixels.
BurninSubtitleTeletextSpacing	teletextSpacing() Only applies to jobs with input captions in Teletext or STL formats.
String	teletextSpacingAsString() Only applies to jobs with input captions in Teletext or STL formats.
BurninDestinationSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	xPosition() Specifies the horizontal position of the caption relative to the left side of the output in pixels.
Integer	yPosition() Specifies the vertical position of the caption relative to the top of the output in pixels.

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

alignment

public final BurninSubtitleAlignment alignment()

If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleAlignment

alignmentAsString

public final String alignmentAsString()

If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleAlignment

backgroundColor

public final BurninSubtitleBackgroundColor backgroundColor()

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleBackgroundColor

backgroundColorAsString

public final String backgroundColorAsString()

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleBackgroundColor

backgroundOpacity

public final Integer backgroundOpacity()

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

fontColor

public final BurninSubtitleFontColor fontColor()

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleFontColor

fontColorAsString

public final String fontColorAsString()

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleFontColor

fontOpacity

public final Integer fontOpacity()

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

fontResolution

public final Integer fontResolution()

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

Returns:

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

fontScript

public final FontScript fontScript()

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.

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

Returns:

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.

See Also:

FontScript

fontScriptAsString

public final String fontScriptAsString()

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.

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

Returns:

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.

See Also:

FontScript

fontSize

public final Integer fontSize()

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

Returns:

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

outlineColor

public final BurninSubtitleOutlineColor outlineColor()

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleOutlineColor

outlineColorAsString

public final String outlineColorAsString()

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleOutlineColor

outlineSize

public final Integer outlineSize()

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowColor

public final BurninSubtitleShadowColor shadowColor()

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleShadowColor

shadowColorAsString

public final String shadowColorAsString()

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

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

Returns:

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

See Also:

BurninSubtitleShadowColor

shadowOpacity

public final Integer shadowOpacity()

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

shadowXOffset

public final Integer shadowXOffset()

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

shadowYOffset

public final Integer shadowYOffset()

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

teletextSpacing

public final BurninSubtitleTeletextSpacing teletextSpacing()

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

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

Returns:

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

See Also:

BurninSubtitleTeletextSpacing

teletextSpacingAsString

public final String teletextSpacingAsString()

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

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

Returns:

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

See Also:

BurninSubtitleTeletextSpacing

xPosition

public final Integer xPosition()

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

yPosition

public final Integer yPosition()

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

toBuilder

public BurninDestinationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>

builder

public static BurninDestinationSettings.Builder builder()

serializableBuilderClass

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