BurninDestinationSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.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()

Constructors
Constructor and Description
`BurninDestinationSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BurninDestinationSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlignment()`
`String`	`getBackgroundColor()`
`Integer`	`getBackgroundOpacity()` Specifies the opacity of the background rectangle.
`String`	`getFontColor()`
`Integer`	`getFontOpacity()` Specifies the opacity of the burned-in captions.
`Integer`	`getFontResolution()` Font resolution in DPI (dots per inch); default is 96 dpi.
`Integer`	`getFontSize()` A positive integer indicates the exact font size in points.
`String`	`getOutlineColor()`
`Integer`	`getOutlineSize()` Specifies font outline size in pixels.
`String`	`getShadowColor()`
`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`	`getTeletextSpacing()`
`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)`
`void`	`setBackgroundColor(String backgroundColor)`
`void`	`setBackgroundOpacity(Integer backgroundOpacity)` Specifies the opacity of the background rectangle.
`void`	`setFontColor(String fontColor)`
`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(Integer fontSize)` A positive integer indicates the exact font size in points.
`void`	`setOutlineColor(String outlineColor)`
`void`	`setOutlineSize(Integer outlineSize)` Specifies font outline size in pixels.
`void`	`setShadowColor(String shadowColor)`
`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`	`setTeletextSpacing(String teletextSpacing)`
`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(BurninSubtitleAlignment alignment)`
`BurninDestinationSettings`	`withAlignment(String alignment)`
`BurninDestinationSettings`	`withBackgroundColor(BurninSubtitleBackgroundColor backgroundColor)`
`BurninDestinationSettings`	`withBackgroundColor(String backgroundColor)`
`BurninDestinationSettings`	`withBackgroundOpacity(Integer backgroundOpacity)` Specifies the opacity of the background rectangle.
`BurninDestinationSettings`	`withFontColor(BurninSubtitleFontColor fontColor)`
`BurninDestinationSettings`	`withFontColor(String fontColor)`
`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(Integer fontSize)` A positive integer indicates the exact font size in points.
`BurninDestinationSettings`	`withOutlineColor(BurninSubtitleOutlineColor outlineColor)`
`BurninDestinationSettings`	`withOutlineColor(String outlineColor)`
`BurninDestinationSettings`	`withOutlineSize(Integer outlineSize)` Specifies font outline size in pixels.
`BurninDestinationSettings`	`withShadowColor(BurninSubtitleShadowColor shadowColor)`
`BurninDestinationSettings`	`withShadowColor(String shadowColor)`
`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`	`withTeletextSpacing(BurninSubtitleTeletextSpacing teletextSpacing)`
`BurninDestinationSettings`	`withTeletextSpacing(String teletextSpacing)`
`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)
```
    Parameters:
    
    alignment -
    
    See Also:
    
    BurninSubtitleAlignment
  - getAlignment
```
public String getAlignment()
```
    Returns:
    
    See Also:
    
    BurninSubtitleAlignment
  - withAlignment
```
public BurninDestinationSettings withAlignment(String alignment)
```
    Parameters:
    
    alignment -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleAlignment
  - withAlignment
```
public BurninDestinationSettings withAlignment(BurninSubtitleAlignment alignment)
```
    Parameters:
    
    alignment -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleAlignment
  - setBackgroundColor
```
public void setBackgroundColor(String backgroundColor)
```
    Parameters:
    
    backgroundColor -
    
    See Also:
    
    BurninSubtitleBackgroundColor
  - getBackgroundColor
```
public String getBackgroundColor()
```
    Returns:
    
    See Also:
    
    BurninSubtitleBackgroundColor
  - withBackgroundColor
```
public BurninDestinationSettings withBackgroundColor(String backgroundColor)
```
    Parameters:
    
    backgroundColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleBackgroundColor
  - withBackgroundColor
```
public BurninDestinationSettings withBackgroundColor(BurninSubtitleBackgroundColor backgroundColor)
```
    Parameters:
    
    backgroundColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleBackgroundColor
  - setBackgroundOpacity
```
public void setBackgroundOpacity(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.
  - getBackgroundOpacity
```
public Integer getBackgroundOpacity()
```
    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.
  - withBackgroundOpacity
```
public BurninDestinationSettings withBackgroundOpacity(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.
  - setFontColor
```
public void setFontColor(String fontColor)
```
    Parameters:
    
    fontColor -
    
    See Also:
    
    BurninSubtitleFontColor
  - getFontColor
```
public String getFontColor()
```
    Returns:
    
    See Also:
    
    BurninSubtitleFontColor
  - withFontColor
```
public BurninDestinationSettings withFontColor(String fontColor)
```
    Parameters:
    
    fontColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleFontColor
  - withFontColor
```
public BurninDestinationSettings withFontColor(BurninSubtitleFontColor fontColor)
```
    Parameters:
    
    fontColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleFontColor
  - 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(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.
  - getFontSize
```
public Integer getFontSize()
```
    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.
  - withFontSize
```
public BurninDestinationSettings withFontSize(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.
  - setOutlineColor
```
public void setOutlineColor(String outlineColor)
```
    Parameters:
    
    outlineColor -
    
    See Also:
    
    BurninSubtitleOutlineColor
  - getOutlineColor
```
public String getOutlineColor()
```
    Returns:
    
    See Also:
    
    BurninSubtitleOutlineColor
  - withOutlineColor
```
public BurninDestinationSettings withOutlineColor(String outlineColor)
```
    Parameters:
    
    outlineColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleOutlineColor
  - withOutlineColor
```
public BurninDestinationSettings withOutlineColor(BurninSubtitleOutlineColor outlineColor)
```
    Parameters:
    
    outlineColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleOutlineColor
  - 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)
```
    Parameters:
    
    shadowColor -
    
    See Also:
    
    BurninSubtitleShadowColor
  - getShadowColor
```
public String getShadowColor()
```
    Returns:
    
    See Also:
    
    BurninSubtitleShadowColor
  - withShadowColor
```
public BurninDestinationSettings withShadowColor(String shadowColor)
```
    Parameters:
    
    shadowColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleShadowColor
  - withShadowColor
```
public BurninDestinationSettings withShadowColor(BurninSubtitleShadowColor shadowColor)
```
    Parameters:
    
    shadowColor -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleShadowColor
  - setShadowOpacity
```
public void setShadowOpacity(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.
  - getShadowOpacity
```
public Integer getShadowOpacity()
```
    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.
  - withShadowOpacity
```
public BurninDestinationSettings withShadowOpacity(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.
  - 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.
  - setTeletextSpacing
```
public void setTeletextSpacing(String teletextSpacing)
```
    Parameters:
    
    teletextSpacing -
    
    See Also:
    
    BurninSubtitleTeletextSpacing
  - getTeletextSpacing
```
public String getTeletextSpacing()
```
    Returns:
    
    See Also:
    
    BurninSubtitleTeletextSpacing
  - withTeletextSpacing
```
public BurninDestinationSettings withTeletextSpacing(String teletextSpacing)
```
    Parameters:
    
    teletextSpacing -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleTeletextSpacing
  - withTeletextSpacing
```
public BurninDestinationSettings withTeletextSpacing(BurninSubtitleTeletextSpacing teletextSpacing)
```
    Parameters:
    
    teletextSpacing -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BurninSubtitleTeletextSpacing
  - 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 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.
  - 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 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.
  - 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 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.
  - 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 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.
  - 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 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.
  - 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 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.
  - 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.

Did this page help you?

Class BurninDestinationSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BurninDestinationSettings

Method Detail

setAlignment

getAlignment

withAlignment

withAlignment

setBackgroundColor

getBackgroundColor

withBackgroundColor

withBackgroundColor

setBackgroundOpacity

getBackgroundOpacity

withBackgroundOpacity

setFontColor

getFontColor

withFontColor

withFontColor

setFontOpacity

getFontOpacity

withFontOpacity

setFontResolution

getFontResolution

withFontResolution

setFontSize

getFontSize

withFontSize

setOutlineColor

getOutlineColor

withOutlineColor

withOutlineColor

setOutlineSize

getOutlineSize

withOutlineSize

setShadowColor

getShadowColor

withShadowColor

withShadowColor

setShadowOpacity

getShadowOpacity

withShadowOpacity

setShadowXOffset

getShadowXOffset

withShadowXOffset

setShadowYOffset

getShadowYOffset

withShadowYOffset

setTeletextSpacing

getTeletextSpacing

withTeletextSpacing

withTeletextSpacing

setXPosition

getXPosition

withXPosition

setYPosition

getYPosition

withYPosition

toString

equals

hashCode

clone

marshall