Package software.amazon.awscdk.cfnpropertymixins.services.medialive

Class CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.medialive.CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnChannelPropsMixin.BurnInDestinationSettingsProperty>

Enclosing interface:

CfnChannelPropsMixin.BurnInDestinationSettingsProperty

@Stability(Stable)
public static final class CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnChannelPropsMixin.BurnInDestinationSettingsProperty>

A builder for CfnChannelPropsMixin.BurnInDestinationSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	alignment(String alignment)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getAlignment()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	backgroundColor(String backgroundColor)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getBackgroundColor()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	backgroundOpacity(Number backgroundOpacity)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getBackgroundOpacity()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty	build()	Builds the configured instance.
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	font(CfnChannelPropsMixin.InputLocationProperty font)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFont()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	font(IResolvable font)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFont()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	fontColor(String fontColor)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontColor()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	fontOpacity(Number fontOpacity)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontOpacity()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	fontResolution(Number fontResolution)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontResolution()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	fontSize(String fontSize)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontSize()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	outlineColor(String outlineColor)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getOutlineColor()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	outlineSize(Number outlineSize)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getOutlineSize()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	shadowColor(String shadowColor)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowColor()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	shadowOpacity(Number shadowOpacity)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowOpacity()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	shadowXOffset(Number shadowXOffset)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowXOffset()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	shadowYOffset(Number shadowYOffset)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowYOffset()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	subtitleRows(String subtitleRows)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getSubtitleRows()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	teletextGridControl(String teletextGridControl)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getTeletextGridControl()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	xPosition(Number xPosition)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getXPosition()
CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder	yPosition(Number yPosition)	Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getYPosition()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

alignment

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder alignment(String alignment)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getAlignment()

Parameters:

alignment - If no explicit xPosition or yPosition is provided, setting alignment to centered places the captions at the bottom center of the output. Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting "smart" justification left-justifies live subtitles and center-justifies pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Returns:

this

backgroundColor

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder backgroundColor(String backgroundColor)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getBackgroundColor()

Parameters:

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

Returns:

this

backgroundOpacity

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder backgroundOpacity(Number backgroundOpacity)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getBackgroundOpacity()

Parameters:

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

Returns:

this

font

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder font(IResolvable font)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFont()

Parameters:

font - The external font file that is used for captions burn-in. The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Returns:

this

font

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder font(CfnChannelPropsMixin.InputLocationProperty font)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFont()

Parameters:

font - The external font file that is used for captions burn-in. The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Returns:

this

fontColor

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder fontColor(String fontColor)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontColor()

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 captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

this

fontOpacity

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder fontOpacity(Number fontOpacity)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontOpacity()

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:

this

fontResolution

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder fontResolution(Number fontResolution)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontResolution()

Parameters:

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

Returns:

this

fontSize

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder fontSize(String fontSize)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getFontSize()

Parameters:

fontSize - When set to auto, fontSize scales depending on the size of the output. Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.

Returns:

this

outlineColor

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder outlineColor(String outlineColor)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getOutlineColor()

Parameters:

outlineColor - Specifies the 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 captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

this

outlineSize

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder outlineSize(Number outlineSize)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getOutlineSize()

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 captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

this

shadowColor

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder shadowColor(String shadowColor)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowColor()

Parameters:

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

Returns:

this

shadowOpacity

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder shadowOpacity(Number shadowOpacity)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowOpacity()

Parameters:

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

Returns:

this

shadowXOffset

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder shadowXOffset(Number shadowXOffset)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowXOffset()

Parameters:

shadowXOffset - Specifies the horizontal offset of the shadow that is 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:

this

shadowYOffset

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder shadowYOffset(Number shadowYOffset)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getShadowYOffset()

Parameters:

shadowYOffset - Specifies the vertical offset of the shadow that is 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:

this

subtitleRows

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder subtitleRows(String subtitleRows)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getSubtitleRows()

Parameters:

subtitleRows - the value to be set.

Returns:

this

teletextGridControl

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder teletextGridControl(String teletextGridControl)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getTeletextGridControl()

Parameters:

teletextGridControl - Controls whether a fixed grid size is used to generate the output subtitles bitmap. This applies only to Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

this

xPosition

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder xPosition(Number xPosition)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getXPosition()

Parameters:

xPosition - Specifies the horizontal position of the captions 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 xPosition is provided, the horizontal captions position is determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

Returns:

this

yPosition

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty.Builder yPosition(Number yPosition)

Sets the value of CfnChannelPropsMixin.BurnInDestinationSettingsProperty.getYPosition()

Parameters:

yPosition - Specifies the vertical position of the captions 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 yPosition is provided, the captions are positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

Returns:

this

build

@Stability(Stable)
public CfnChannelPropsMixin.BurnInDestinationSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnChannelPropsMixin.BurnInDestinationSettingsProperty>

Returns:

a new instance of CfnChannelPropsMixin.BurnInDestinationSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided