Package software.amazon.awscdk.services.medialive.alpha

Class CaptionFontStyleProps.Builder

java.lang.Object

software.amazon.awscdk.services.medialive.alpha.CaptionFontStyleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CaptionFontStyleProps>

Enclosing interface:

CaptionFontStyleProps

@Stability(Experimental)
public static final class CaptionFontStyleProps.Builder
extends Object
implements software.amazon.jsii.Builder<CaptionFontStyleProps>

A builder for CaptionFontStyleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CaptionFontStyleProps.Builder	alignment(CaptionAlignment alignment)	Sets the value of CaptionFontStyleProps.getAlignment()
CaptionFontStyleProps.Builder	backgroundColor(CaptionBackgroundColor backgroundColor)	Sets the value of CaptionFontStyleProps.getBackgroundColor()
CaptionFontStyleProps.Builder	backgroundOpacity(Number backgroundOpacity)	Sets the value of CaptionFontStyleProps.getBackgroundOpacity()
CaptionFontStyleProps	build()	Builds the configured instance.
CaptionFontStyleProps.Builder	font(FileLocation font)	Sets the value of CaptionFontStyleProps.getFont()
CaptionFontStyleProps.Builder	fontColor(CaptionFontColor fontColor)	Sets the value of CaptionFontStyleProps.getFontColor()
CaptionFontStyleProps.Builder	fontOpacity(Number fontOpacity)	Sets the value of CaptionFontStyleProps.getFontOpacity()
CaptionFontStyleProps.Builder	fontResolution(Number fontResolution)	Sets the value of CaptionFontStyleProps.getFontResolution()
CaptionFontStyleProps.Builder	fontSize(CaptionFontSize fontSize)	Sets the value of CaptionFontStyleProps.getFontSize()
CaptionFontStyleProps.Builder	outlineColor(CaptionOutlineColor outlineColor)	Sets the value of CaptionFontStyleProps.getOutlineColor()
CaptionFontStyleProps.Builder	outlineSize(Number outlineSize)	Sets the value of CaptionFontStyleProps.getOutlineSize()
CaptionFontStyleProps.Builder	shadowColor(CaptionShadowColor shadowColor)	Sets the value of CaptionFontStyleProps.getShadowColor()
CaptionFontStyleProps.Builder	shadowOpacity(Number shadowOpacity)	Sets the value of CaptionFontStyleProps.getShadowOpacity()
CaptionFontStyleProps.Builder	shadowXOffset(Number shadowXOffset)	Sets the value of CaptionFontStyleProps.getShadowXOffset()
CaptionFontStyleProps.Builder	shadowYOffset(Number shadowYOffset)	Sets the value of CaptionFontStyleProps.getShadowYOffset()
CaptionFontStyleProps.Builder	subtitleRows(String subtitleRows)	Sets the value of CaptionFontStyleProps.getSubtitleRows()
CaptionFontStyleProps.Builder	teletextGridControl(CaptionTeletextGridControl teletextGridControl)	Sets the value of CaptionFontStyleProps.getTeletextGridControl()
CaptionFontStyleProps.Builder	xPosition(Number xPosition)	Sets the value of CaptionFontStyleProps.getXPosition()
CaptionFontStyleProps.Builder	yPosition(Number yPosition)	Sets the value of CaptionFontStyleProps.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(Experimental)
public CaptionFontStyleProps.Builder alignment(CaptionAlignment alignment)

Sets the value of CaptionFontStyleProps.getAlignment()

Parameters:

alignment - Caption alignment. With explicit x/y positions, the font is justified relative to them.

Returns:

this

backgroundColor

@Stability(Experimental)
public CaptionFontStyleProps.Builder backgroundColor(CaptionBackgroundColor backgroundColor)

Sets the value of CaptionFontStyleProps.getBackgroundColor()

Parameters:

backgroundColor - The color of the rectangle behind the captions.

Returns:

this

backgroundOpacity

@Stability(Experimental)
public CaptionFontStyleProps.Builder backgroundOpacity(Number backgroundOpacity)

Sets the value of CaptionFontStyleProps.getBackgroundOpacity()

Parameters:

backgroundOpacity - The opacity of the background rectangle (0 transparent .. 255 opaque).

Returns:

this

font

@Stability(Experimental)
public CaptionFontStyleProps.Builder font(FileLocation font)

Sets the value of CaptionFontStyleProps.getFont()

Parameters:

font - An external font file (.ttf or .tte) used for burn-in. Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url).

Returns:

this

fontColor

@Stability(Experimental)
public CaptionFontStyleProps.Builder fontColor(CaptionFontColor fontColor)

Sets the value of CaptionFontStyleProps.getFontColor()

Parameters:

fontColor - The color of the burned-in captions.

Returns:

this

fontOpacity

@Stability(Experimental)
public CaptionFontStyleProps.Builder fontOpacity(Number fontOpacity)

Sets the value of CaptionFontStyleProps.getFontOpacity()

Parameters:

fontOpacity - The opacity of the burned-in captions (0 transparent .. 255 opaque).

Returns:

this

fontResolution

@Stability(Experimental)
public CaptionFontStyleProps.Builder fontResolution(Number fontResolution)

Sets the value of CaptionFontStyleProps.getFontResolution()

Parameters:

fontResolution - The font resolution in DPI.

Returns:

this

fontSize

@Stability(Experimental)
public CaptionFontStyleProps.Builder fontSize(CaptionFontSize fontSize)

Sets the value of CaptionFontStyleProps.getFontSize()

Parameters:

fontSize - Font size — CaptionFontSize.AUTO to scale with the output, or CaptionFontSize.of(points) for an exact size in points.

Returns:

this

outlineColor

@Stability(Experimental)
public CaptionFontStyleProps.Builder outlineColor(CaptionOutlineColor outlineColor)

Sets the value of CaptionFontStyleProps.getOutlineColor()

Parameters:

outlineColor - The font outline color.

Returns:

this

outlineSize

@Stability(Experimental)
public CaptionFontStyleProps.Builder outlineSize(Number outlineSize)

Sets the value of CaptionFontStyleProps.getOutlineSize()

Parameters:

outlineSize - The font outline size in pixels.

Returns:

this

shadowColor

@Stability(Experimental)
public CaptionFontStyleProps.Builder shadowColor(CaptionShadowColor shadowColor)

Sets the value of CaptionFontStyleProps.getShadowColor()

Parameters:

shadowColor - The color of the shadow cast by the captions.

Returns:

this

shadowOpacity

@Stability(Experimental)
public CaptionFontStyleProps.Builder shadowOpacity(Number shadowOpacity)

Sets the value of CaptionFontStyleProps.getShadowOpacity()

Parameters:

shadowOpacity - The opacity of the shadow (0 transparent .. 255 opaque).

Returns:

this

shadowXOffset

@Stability(Experimental)
public CaptionFontStyleProps.Builder shadowXOffset(Number shadowXOffset)

Sets the value of CaptionFontStyleProps.getShadowXOffset()

Parameters:

shadowXOffset - The horizontal offset of the shadow in pixels (negative shifts left).

Returns:

this

shadowYOffset

@Stability(Experimental)
public CaptionFontStyleProps.Builder shadowYOffset(Number shadowYOffset)

Sets the value of CaptionFontStyleProps.getShadowYOffset()

Parameters:

shadowYOffset - The vertical offset of the shadow in pixels (negative shifts up).

Returns:

this

subtitleRows

@Stability(Experimental)
public CaptionFontStyleProps.Builder subtitleRows(String subtitleRows)

Sets the value of CaptionFontStyleProps.getSubtitleRows()

Parameters:

subtitleRows - For Teletext input, the number of lines for the captions bitmap.

Returns:

this

teletextGridControl

@Stability(Experimental)
public CaptionFontStyleProps.Builder teletextGridControl(CaptionTeletextGridControl teletextGridControl)

Sets the value of CaptionFontStyleProps.getTeletextGridControl()

Parameters:

teletextGridControl - Whether a fixed grid is used to generate the subtitle bitmap (Teletext input).

Returns:

this

xPosition

@Stability(Experimental)
public CaptionFontStyleProps.Builder xPosition(Number xPosition)

Sets the value of CaptionFontStyleProps.getXPosition()

Parameters:

xPosition - The horizontal position of the captions in pixels from the left.

Returns:

this

yPosition

@Stability(Experimental)
public CaptionFontStyleProps.Builder yPosition(Number yPosition)

Sets the value of CaptionFontStyleProps.getYPosition()

Parameters:

yPosition - The vertical position of the captions in pixels from the top.

Returns:

this

build

@Stability(Experimental)
public CaptionFontStyleProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CaptionFontStyleProps>

Returns:

a new instance of CaptionFontStyleProps

Throws:

NullPointerException - if any required attribute was not provided