com.amazonaws.services.medialive.model

Class BurnInDestinationSettings

java.lang.Object

com.amazonaws.services.medialive.model.BurnInDestinationSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BurnInDestinationSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Burn In Destination Settings

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BurnInDestinationSettings()

Method Summary

Modifier and Type	Method and Description
BurnInDestinationSettings	clone()
boolean	equals(Object obj)
String	getAlignment() If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
String	getBackgroundColor() Specifies the color of the rectangle behind the captions.
Integer	getBackgroundOpacity() Specifies the opacity of the background rectangle.
InputLocation	getFont() External font file used for caption burn-in.
String	getFontColor() Specifies the color of the burned-in captions.
Integer	getFontOpacity() Specifies the opacity of the burned-in captions.
Integer	getFontResolution() Font resolution in DPI (dots per inch); default is 96 dpi.
String	getFontSize() When set to 'auto' fontSize will scale depending on the size of the output.
String	getOutlineColor() Specifies font outline color.
Integer	getOutlineSize() Specifies font outline size in pixels.
String	getShadowColor() Specifies the color of the shadow cast by the captions.
Integer	getShadowOpacity() Specifies the opacity of the shadow.
Integer	getShadowXOffset() Specifies the horizontal offset of the shadow relative to the captions in pixels.
Integer	getShadowYOffset() Specifies the vertical offset of the shadow relative to the captions in pixels.
String	getTeletextGridControl() Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
Integer	getXPosition() Specifies the horizontal position of the caption relative to the left side of the output in pixels.
Integer	getYPosition() Specifies the vertical position of the caption relative to the top of the output in pixels.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAlignment(String alignment) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
void	setBackgroundColor(String backgroundColor) Specifies the color of the rectangle behind the captions.
void	setBackgroundOpacity(Integer backgroundOpacity) Specifies the opacity of the background rectangle.
void	setFont(InputLocation font) External font file used for caption burn-in.
void	setFontColor(String fontColor) Specifies the color of the burned-in captions.
void	setFontOpacity(Integer fontOpacity) Specifies the opacity of the burned-in captions.
void	setFontResolution(Integer fontResolution) Font resolution in DPI (dots per inch); default is 96 dpi.
void	setFontSize(String fontSize) When set to 'auto' fontSize will scale depending on the size of the output.
void	setOutlineColor(String outlineColor) Specifies font outline color.
void	setOutlineSize(Integer outlineSize) Specifies font outline size in pixels.
void	setShadowColor(String shadowColor) Specifies the color of the shadow cast by the captions.
void	setShadowOpacity(Integer shadowOpacity) Specifies the opacity of the shadow.
void	setShadowXOffset(Integer shadowXOffset) Specifies the horizontal offset of the shadow relative to the captions in pixels.
void	setShadowYOffset(Integer shadowYOffset) Specifies the vertical offset of the shadow relative to the captions in pixels.
void	setTeletextGridControl(String teletextGridControl) Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
void	setXPosition(Integer xPosition) Specifies the horizontal position of the caption relative to the left side of the output in pixels.
void	setYPosition(Integer yPosition) Specifies the vertical position of the caption relative to the top of the output in pixels.
String	toString() Returns a string representation of this object.
BurnInDestinationSettings	withAlignment(BurnInAlignment alignment) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
BurnInDestinationSettings	withAlignment(String alignment) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
BurnInDestinationSettings	withBackgroundColor(BurnInBackgroundColor backgroundColor) Specifies the color of the rectangle behind the captions.
BurnInDestinationSettings	withBackgroundColor(String backgroundColor) Specifies the color of the rectangle behind the captions.
BurnInDestinationSettings	withBackgroundOpacity(Integer backgroundOpacity) Specifies the opacity of the background rectangle.
BurnInDestinationSettings	withFont(InputLocation font) External font file used for caption burn-in.
BurnInDestinationSettings	withFontColor(BurnInFontColor fontColor) Specifies the color of the burned-in captions.
BurnInDestinationSettings	withFontColor(String fontColor) Specifies the color of the burned-in captions.
BurnInDestinationSettings	withFontOpacity(Integer fontOpacity) Specifies the opacity of the burned-in captions.
BurnInDestinationSettings	withFontResolution(Integer fontResolution) Font resolution in DPI (dots per inch); default is 96 dpi.
BurnInDestinationSettings	withFontSize(String fontSize) When set to 'auto' fontSize will scale depending on the size of the output.
BurnInDestinationSettings	withOutlineColor(BurnInOutlineColor outlineColor) Specifies font outline color.
BurnInDestinationSettings	withOutlineColor(String outlineColor) Specifies font outline color.
BurnInDestinationSettings	withOutlineSize(Integer outlineSize) Specifies font outline size in pixels.
BurnInDestinationSettings	withShadowColor(BurnInShadowColor shadowColor) Specifies the color of the shadow cast by the captions.
BurnInDestinationSettings	withShadowColor(String shadowColor) Specifies the color of the shadow cast by the captions.
BurnInDestinationSettings	withShadowOpacity(Integer shadowOpacity) Specifies the opacity of the shadow.
BurnInDestinationSettings	withShadowXOffset(Integer shadowXOffset) Specifies the horizontal offset of the shadow relative to the captions in pixels.
BurnInDestinationSettings	withShadowYOffset(Integer shadowYOffset) Specifies the vertical offset of the shadow relative to the captions in pixels.
BurnInDestinationSettings	withTeletextGridControl(BurnInTeletextGridControl teletextGridControl) Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
BurnInDestinationSettings	withTeletextGridControl(String teletextGridControl) Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
BurnInDestinationSettings	withXPosition(Integer xPosition) Specifies the horizontal position of the caption relative to the left side of the output in pixels.
BurnInDestinationSettings	withYPosition(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BurnInDestinationSettings

public BurnInDestinationSettings()

Method Detail

setAlignment

public void setAlignment(String alignment)

If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Parameters:

alignment - If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInAlignment

getAlignment

public String getAlignment()

If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Returns:

If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

See Also:

BurnInAlignment

withAlignment

public BurnInDestinationSettings withAlignment(String alignment)

If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Parameters:

alignment - If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. 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:

BurnInAlignment

withAlignment

public BurnInDestinationSettings withAlignment(BurnInAlignment alignment)

If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Parameters:

alignment - If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. 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:

BurnInAlignment

setBackgroundColor

public void setBackgroundColor(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.

See Also:

BurnInBackgroundColor

getBackgroundColor

public String getBackgroundColor()

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

Returns:

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

See Also:

BurnInBackgroundColor

withBackgroundColor

public BurnInDestinationSettings withBackgroundColor(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:

BurnInBackgroundColor

withBackgroundColor

public BurnInDestinationSettings withBackgroundColor(BurnInBackgroundColor 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:

BurnInBackgroundColor

setBackgroundOpacity

public void setBackgroundOpacity(Integer backgroundOpacity)

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

getBackgroundOpacity

public Integer getBackgroundOpacity()

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

withBackgroundOpacity

public BurnInDestinationSettings withBackgroundOpacity(Integer backgroundOpacity)

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out 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.

setFont

public void setFont(InputLocation font)

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Parameters:

font - External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

getFont

public InputLocation getFont()

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Returns:

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

withFont

public BurnInDestinationSettings withFont(InputLocation font)

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Parameters:

font - External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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 caption sources could cause unexpected display of proportional fonts. 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.

setFontColor

public void setFontColor(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.

See Also:

BurnInFontColor

getFontColor

public String getFontColor()

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:

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:

BurnInFontColor

withFontColor

public BurnInDestinationSettings withFontColor(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:

BurnInFontColor

withFontColor

public BurnInDestinationSettings withFontColor(BurnInFontColor 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:

BurnInFontColor

setFontOpacity

public void setFontOpacity(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.

getFontOpacity

public Integer getFontOpacity()

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.

withFontOpacity

public BurnInDestinationSettings withFontOpacity(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.

setFontResolution

public void setFontResolution(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.

getFontResolution

public Integer getFontResolution()

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.

withFontResolution

public BurnInDestinationSettings withFontResolution(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.

setFontSize

public void setFontSize(String fontSize)

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

Parameters:

fontSize - When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

getFontSize

public String getFontSize()

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

Returns:

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

withFontSize

public BurnInDestinationSettings withFontSize(String fontSize)

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

Parameters:

fontSize - When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. 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.

setOutlineColor

public void setOutlineColor(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.

See Also:

BurnInOutlineColor

getOutlineColor

public String getOutlineColor()

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:

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:

BurnInOutlineColor

withOutlineColor

public BurnInDestinationSettings withOutlineColor(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:

BurnInOutlineColor

withOutlineColor

public BurnInDestinationSettings withOutlineColor(BurnInOutlineColor 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:

BurnInOutlineColor

setOutlineSize

public void setOutlineSize(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.

getOutlineSize

public Integer getOutlineSize()

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.

withOutlineSize

public BurnInDestinationSettings withOutlineSize(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.

setShadowColor

public void setShadowColor(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.

See Also:

BurnInShadowColor

getShadowColor

public String getShadowColor()

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

Returns:

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

See Also:

BurnInShadowColor

withShadowColor

public BurnInDestinationSettings withShadowColor(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:

BurnInShadowColor

withShadowColor

public BurnInDestinationSettings withShadowColor(BurnInShadowColor 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:

BurnInShadowColor

setShadowOpacity

public void setShadowOpacity(Integer shadowOpacity)

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

getShadowOpacity

public Integer getShadowOpacity()

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

withShadowOpacity

public BurnInDestinationSettings withShadowOpacity(Integer shadowOpacity)

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out 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 out 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.

setShadowXOffset

public void setShadowXOffset(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.

getShadowXOffset

public Integer getShadowXOffset()

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.

withShadowXOffset

public BurnInDestinationSettings withShadowXOffset(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.

setShadowYOffset

public void setShadowYOffset(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.

getShadowYOffset

public Integer getShadowYOffset()

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.

withShadowYOffset

public BurnInDestinationSettings withShadowYOffset(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.

setTeletextGridControl

public void setTeletextGridControl(String teletextGridControl)

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Parameters:

teletextGridControl - Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

See Also:

BurnInTeletextGridControl

getTeletextGridControl

public String getTeletextGridControl()

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

See Also:

BurnInTeletextGridControl

withTeletextGridControl

public BurnInDestinationSettings withTeletextGridControl(String teletextGridControl)

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Parameters:

teletextGridControl - Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

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

See Also:

BurnInTeletextGridControl

withTeletextGridControl

public BurnInDestinationSettings withTeletextGridControl(BurnInTeletextGridControl teletextGridControl)

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Parameters:

teletextGridControl - Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

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

See Also:

BurnInTeletextGridControl

setXPosition

public void setXPosition(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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. 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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

getXPosition

public Integer getXPosition()

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

withXPosition

public BurnInDestinationSettings withXPosition(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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. 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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. 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.

setYPosition

public void setYPosition(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 yPosition is provided, the caption will be positioned towards the bottom of the output. 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 yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

getYPosition

public Integer getYPosition()

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 yPosition is provided, the caption will be positioned towards the bottom of the output. 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 yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

withYPosition

public BurnInDestinationSettings withYPosition(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 yPosition is provided, the caption will be positioned towards the bottom of the output. 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 yPosition is provided, the caption will be positioned towards the bottom of the output. 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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BurnInDestinationSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.