java.lang.Object
- software.amazon.awssdk.services.medialive.model.BurnInDestinationSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>

@Generated("software.amazon.awssdk:codegen")
public final class BurnInDestinationSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>

Burn In Destination Settings

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BurnInDestinationSettings.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`String`	`alignmentAsString()`	If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output.
`BurnInBackgroundColor`	`backgroundColor()`	Specifies the color of the rectangle behind the captions.
`String`	`backgroundColorAsString()`	Specifies the color of the rectangle behind the captions.
`Integer`	`backgroundOpacity()`	Specifies the opacity of the background rectangle.
`static BurnInDestinationSettings.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`InputLocation`	`font()`	External font file used for caption burn-in.
`BurnInFontColor`	`fontColor()`	Specifies the color of the burned-in captions.
`String`	`fontColorAsString()`	Specifies the color of the burned-in captions.
`Integer`	`fontOpacity()`	Specifies the opacity of the burned-in captions.
`Integer`	`fontResolution()`	Font resolution in DPI (dots per inch); default is 96 dpi.
`String`	`fontSize()`	When set to 'auto' fontSize will scale depending on the size of the output.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`BurnInOutlineColor`	`outlineColor()`	Specifies font outline color.
`String`	`outlineColorAsString()`	Specifies font outline color.
`Integer`	`outlineSize()`	Specifies font outline size in pixels.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BurnInDestinationSettings.Builder>`	`serializableBuilderClass()`
`BurnInShadowColor`	`shadowColor()`	Specifies the color of the shadow cast by the captions.
`String`	`shadowColorAsString()`	Specifies the color of the shadow cast by the captions.
`Integer`	`shadowOpacity()`	Specifies the opacity of the shadow.
`Integer`	`shadowXOffset()`	Specifies the horizontal offset of the shadow relative to the captions in pixels.
`Integer`	`shadowYOffset()`	Specifies the vertical offset of the shadow relative to the captions in pixels.
`BurnInTeletextGridControl`	`teletextGridControl()`	Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
`String`	`teletextGridControlAsString()`	Controls whether a fixed grid size will be used to generate the output subtitles bitmap.
`BurnInDestinationSettings.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`xPosition()`	Specifies the horizontal position of the caption relative to the left side of the output in pixels.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - alignment
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, alignment will return BurnInAlignment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alignmentAsString().
    
    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
  - alignmentAsString
```
public final String alignmentAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, alignment will return BurnInAlignment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alignmentAsString().
    
    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
  - backgroundColor
```
public final BurnInBackgroundColor backgroundColor()
```
    Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
    If the service returns an enum value that is not available in the current SDK version, backgroundColor will return BurnInBackgroundColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundColorAsString().
    
    Returns:
    
    Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
    
    See Also:
    
    BurnInBackgroundColor
  - backgroundColorAsString
```
public final String backgroundColorAsString()
```
    Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
    If the service returns an enum value that is not available in the current SDK version, backgroundColor will return BurnInBackgroundColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backgroundColorAsString().
    
    Returns:
    
    Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
    
    See Also:
    
    BurnInBackgroundColor
  - backgroundOpacity
```
public final 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.
    
    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.
  - font
```
public final 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.
    
    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.
  - fontColor
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, fontColor will return BurnInFontColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontColorAsString().
    
    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
  - fontColorAsString
```
public final String fontColorAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, fontColor will return BurnInFontColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fontColorAsString().
    
    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
  - fontOpacity
```
public final 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.
    
    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.
  - fontResolution
```
public final Integer fontResolution()
```
    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.
  - fontSize
```
public final 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.
    
    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.
  - outlineColor
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, outlineColor will return BurnInOutlineColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outlineColorAsString().
    
    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
  - outlineColorAsString
```
public final String outlineColorAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, outlineColor will return BurnInOutlineColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outlineColorAsString().
    
    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
  - outlineSize
```
public final 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.
    
    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.
  - shadowColor
```
public final BurnInShadowColor shadowColor()
```
    Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
    If the service returns an enum value that is not available in the current SDK version, shadowColor will return BurnInShadowColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shadowColorAsString().
    
    Returns:
    
    Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
    
    See Also:
    
    BurnInShadowColor
  - shadowColorAsString
```
public final String shadowColorAsString()
```
    Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
    If the service returns an enum value that is not available in the current SDK version, shadowColor will return BurnInShadowColor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shadowColorAsString().
    
    Returns:
    
    Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
    
    See Also:
    
    BurnInShadowColor
  - shadowOpacity
```
public final 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.
    
    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.
  - shadowXOffset
```
public final 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.
    
    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.
  - shadowYOffset
```
public final 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.
    
    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.
  - teletextGridControl
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, teletextGridControl will return BurnInTeletextGridControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from teletextGridControlAsString().
    
    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
  - teletextGridControlAsString
```
public final String teletextGridControlAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, teletextGridControl will return BurnInTeletextGridControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from teletextGridControlAsString().
    
    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
  - xPosition
```
public final 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.
    
    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.
  - yPosition
```
public final 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.
    
    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.
  - toBuilder
```
public BurnInDestinationSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BurnInDestinationSettings.Builder,BurnInDestinationSettings>
  - builder
```
public static BurnInDestinationSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BurnInDestinationSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class BurnInDestinationSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

alignment

alignmentAsString

backgroundColor

backgroundColorAsString

backgroundOpacity

font

fontColor

fontColorAsString

fontOpacity

fontResolution

fontSize

outlineColor

outlineColorAsString

outlineSize

shadowColor

shadowColorAsString

shadowOpacity

shadowXOffset

shadowYOffset

teletextGridControl

teletextGridControlAsString

xPosition

yPosition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField