software.amazon.awssdk.services.mediaconvert.model

Interface BurninDestinationSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>, SdkBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>, SdkPojo

Enclosing class:

BurninDestinationSettings

public static interface BurninDestinationSettings.Builder
extends SdkPojo, CopyableBuilder<BurninDestinationSettings.Builder,BurninDestinationSettings>

Method Summary

Modifier and Type	Method and Description
BurninDestinationSettings.Builder	alignment(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.
BurninDestinationSettings.Builder	alignment(String 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.
BurninDestinationSettings.Builder	backgroundColor(BurninSubtitleBackgroundColor backgroundColor) Specifies the color of the rectangle behind the captions.
BurninDestinationSettings.Builder	backgroundColor(String backgroundColor) Specifies the color of the rectangle behind the captions.
BurninDestinationSettings.Builder	backgroundOpacity(Integer backgroundOpacity) Specifies the opacity of the background rectangle.
BurninDestinationSettings.Builder	fontColor(BurninSubtitleFontColor fontColor) Specifies the color of the burned-in captions.
BurninDestinationSettings.Builder	fontColor(String fontColor) Specifies the color of the burned-in captions.
BurninDestinationSettings.Builder	fontOpacity(Integer fontOpacity) Specifies the opacity of the burned-in captions.
BurninDestinationSettings.Builder	fontResolution(Integer fontResolution) Font resolution in DPI (dots per inch); default is 96 dpi.
BurninDestinationSettings.Builder	fontScript(FontScript fontScript) Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type.
BurninDestinationSettings.Builder	fontScript(String fontScript) Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type.
BurninDestinationSettings.Builder	fontSize(Integer fontSize) A positive integer indicates the exact font size in points.
BurninDestinationSettings.Builder	outlineColor(BurninSubtitleOutlineColor outlineColor) Specifies font outline color.
BurninDestinationSettings.Builder	outlineColor(String outlineColor) Specifies font outline color.
BurninDestinationSettings.Builder	outlineSize(Integer outlineSize) Specifies font outline size in pixels.
BurninDestinationSettings.Builder	shadowColor(BurninSubtitleShadowColor shadowColor) Specifies the color of the shadow cast by the captions.
BurninDestinationSettings.Builder	shadowColor(String shadowColor) Specifies the color of the shadow cast by the captions.
BurninDestinationSettings.Builder	shadowOpacity(Integer shadowOpacity) Specifies the opacity of the shadow.
BurninDestinationSettings.Builder	shadowXOffset(Integer shadowXOffset) Specifies the horizontal offset of the shadow relative to the captions in pixels.
BurninDestinationSettings.Builder	shadowYOffset(Integer shadowYOffset) Specifies the vertical offset of the shadow relative to the captions in pixels.
BurninDestinationSettings.Builder	teletextSpacing(BurninSubtitleTeletextSpacing teletextSpacing) Only applies to jobs with input captions in Teletext or STL formats.
BurninDestinationSettings.Builder	teletextSpacing(String teletextSpacing) Only applies to jobs with input captions in Teletext or STL formats.
BurninDestinationSettings.Builder	xPosition(Integer xPosition) Specifies the horizontal position of the caption relative to the left side of the output in pixels.
BurninDestinationSettings.Builder	yPosition(Integer yPosition) Specifies the vertical position of the caption relative to the top of the output in pixels.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

alignment

BurninDestinationSettings.Builder alignment(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleAlignment, BurninSubtitleAlignment

alignment

BurninDestinationSettings.Builder alignment(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleAlignment, BurninSubtitleAlignment

backgroundColor

BurninDestinationSettings.Builder backgroundColor(String backgroundColor)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleBackgroundColor, BurninSubtitleBackgroundColor

backgroundColor

BurninDestinationSettings.Builder backgroundColor(BurninSubtitleBackgroundColor backgroundColor)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleBackgroundColor, BurninSubtitleBackgroundColor

backgroundOpacity

BurninDestinationSettings.Builder backgroundOpacity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

fontColor

BurninDestinationSettings.Builder fontColor(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleFontColor, BurninSubtitleFontColor

fontColor

BurninDestinationSettings.Builder fontColor(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleFontColor, BurninSubtitleFontColor

fontOpacity

BurninDestinationSettings.Builder fontOpacity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

fontResolution

BurninDestinationSettings.Builder fontResolution(Integer fontResolution)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fontScript

BurninDestinationSettings.Builder fontScript(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FontScript, FontScript

fontScript

BurninDestinationSettings.Builder fontScript(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FontScript, FontScript

fontSize

BurninDestinationSettings.Builder fontSize(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

outlineColor

BurninDestinationSettings.Builder outlineColor(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleOutlineColor, BurninSubtitleOutlineColor

outlineColor

BurninDestinationSettings.Builder outlineColor(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleOutlineColor, BurninSubtitleOutlineColor

outlineSize

BurninDestinationSettings.Builder outlineSize(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

shadowColor

BurninDestinationSettings.Builder shadowColor(String shadowColor)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleShadowColor, BurninSubtitleShadowColor

shadowColor

BurninDestinationSettings.Builder shadowColor(BurninSubtitleShadowColor shadowColor)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleShadowColor, BurninSubtitleShadowColor

shadowOpacity

BurninDestinationSettings.Builder shadowOpacity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

shadowXOffset

BurninDestinationSettings.Builder shadowXOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

shadowYOffset

BurninDestinationSettings.Builder shadowYOffset(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

teletextSpacing

BurninDestinationSettings.Builder teletextSpacing(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleTeletextSpacing, BurninSubtitleTeletextSpacing

teletextSpacing

BurninDestinationSettings.Builder teletextSpacing(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BurninSubtitleTeletextSpacing, BurninSubtitleTeletextSpacing

xPosition

BurninDestinationSettings.Builder xPosition(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

yPosition

BurninDestinationSettings.Builder yPosition(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.