CfnChannel.BurnInDestinationSettingsProperty

All Known Implementing Classes:: CfnChannel.BurnInDestinationSettingsProperty.Jsii$Proxy

Enclosing class:: CfnChannel

public static interface CfnChannel.BurnInDestinationSettingsProperty

The settings for burn-in captions in the output.

The parent of this entity is CaptionDestinationSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 BurnInDestinationSettingsProperty burnInDestinationSettingsProperty = BurnInDestinationSettingsProperty.builder()
         .alignment("alignment")
         .backgroundColor("backgroundColor")
         .backgroundOpacity(123)
         .font(InputLocationProperty.builder()
                 .passwordParam("passwordParam")
                 .uri("uri")
                 .username("username")
                 .build())
         .fontColor("fontColor")
         .fontOpacity(123)
         .fontResolution(123)
         .fontSize("fontSize")
         .outlineColor("outlineColor")
         .outlineSize(123)
         .shadowColor("shadowColor")
         .shadowOpacity(123)
         .shadowXOffset(123)
         .shadowYOffset(123)
         .teletextGridControl("teletextGridControl")
         .xPosition(123)
         .yPosition(123)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnChannel.BurnInDestinationSettingsProperty.Builder` A builder for `CfnChannel.BurnInDestinationSettingsProperty`
`static class`	`CfnChannel.BurnInDestinationSettingsProperty.Jsii$Proxy` An implementation for `CfnChannel.BurnInDestinationSettingsProperty`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnChannel.BurnInDestinationSettingsProperty.Builder`	`builder()`
`default java.lang.String`	`getAlignment()` If no explicit xPosition or yPosition is provided, setting alignment to centered places the captions at the bottom center of the output.
`default java.lang.String`	`getBackgroundColor()` Specifies the color of the rectangle behind the captions.
`default java.lang.Number`	`getBackgroundOpacity()` Specifies the opacity of the background rectangle.
`default java.lang.Object`	`getFont()` The external font file that is used for captions burn-in.
`default java.lang.String`	`getFontColor()` Specifies the color of the burned-in captions.
`default java.lang.Number`	`getFontOpacity()` Specifies the opacity of the burned-in captions.
`default java.lang.Number`	`getFontResolution()` The font resolution in DPI (dots per inch).
`default java.lang.String`	`getFontSize()` When set to auto, fontSize scales depending on the size of the output.
`default java.lang.String`	`getOutlineColor()` Specifies the font outline color.
`default java.lang.Number`	`getOutlineSize()` Specifies font outline size in pixels.
`default java.lang.String`	`getShadowColor()` Specifies the color of the shadow cast by the captions.
`default java.lang.Number`	`getShadowOpacity()` Specifies the opacity of the shadow.
`default java.lang.Number`	`getShadowXOffset()` Specifies the horizontal offset of the shadow that is relative to the captions in pixels.
`default java.lang.Number`	`getShadowYOffset()` Specifies the vertical offset of the shadow that is relative to the captions in pixels.
`default java.lang.String`	`getTeletextGridControl()` Controls whether a fixed grid size is used to generate the output subtitles bitmap.
`default java.lang.Number`	`getXPosition()` Specifies the horizontal position of the captions relative to the left side of the output in pixels.
`default java.lang.Number`	`getYPosition()` Specifies the vertical position of the captions relative to the top of the output in pixels.

- Method Detail
  - getAlignment
```
default java.lang.String getAlignment()
```
    If no explicit xPosition or yPosition is provided, setting alignment to centered places the captions at the bottom center of the output.
    Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting "smart" justification left-justifies live subtitles and center-justifies pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
  - getBackgroundColor
```
default java.lang.String getBackgroundColor()
```
    Specifies the color of the rectangle behind the captions.
    All burn-in and DVB-Sub font settings must match.
  - getBackgroundOpacity
```
default java.lang.Number getBackgroundOpacity()
```
    Specifies the opacity of the background rectangle.
    255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
  - getFont
```
default java.lang.Object getFont()
```
    The external font file that is used for captions burn-in.
    The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
  - getFontColor
```
default java.lang.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 captions stream. All burn-in and DVB-Sub font settings must match.
  - getFontOpacity
```
default java.lang.Number 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.
  - getFontResolution
```
default java.lang.Number getFontResolution()
```
    The font resolution in DPI (dots per inch).
    The default is 96 dpi. All burn-in and DVB-Sub font settings must match.
  - getFontSize
```
default java.lang.String getFontSize()
```
    When set to auto, fontSize scales depending on the size of the output.
    Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.
  - getOutlineColor
```
default java.lang.String getOutlineColor()
```
    Specifies the font outline color.
    This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
  - getOutlineSize
```
default java.lang.Number 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 captions stream. All burn-in and DVB-Sub font settings must match.
  - getShadowColor
```
default java.lang.String getShadowColor()
```
    Specifies the color of the shadow cast by the captions.
    All burn-in and DVB-Sub font settings must match.
  - getShadowOpacity
```
default java.lang.Number getShadowOpacity()
```
    Specifies the opacity of the shadow.
    255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
  - getShadowXOffset
```
default java.lang.Number getShadowXOffset()
```
    Specifies the horizontal offset of the shadow that is relative to the captions in pixels.
    A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
  - getShadowYOffset
```
default java.lang.Number getShadowYOffset()
```
    Specifies the vertical offset of the shadow that is relative to the captions in pixels.
    A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
  - getTeletextGridControl
```
default java.lang.String getTeletextGridControl()
```
    Controls whether a fixed grid size is used to generate the output subtitles bitmap.
    This applies only to Teletext inputs and DVB-Sub/Burn-in outputs.
  - getXPosition
```
default java.lang.Number getXPosition()
```
    Specifies the horizontal position of the captions relative to the left side of the output in pixels.
    A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
  - getYPosition
```
default java.lang.Number getYPosition()
```
    Specifies the vertical position of the captions relative to the top of the output in pixels.
    A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
  - builder
```
static CfnChannel.BurnInDestinationSettingsProperty.Builder builder()
```
    Returns:
    
    a CfnChannel.BurnInDestinationSettingsProperty.Builder of CfnChannel.BurnInDestinationSettingsProperty

Interface CfnChannel.BurnInDestinationSettingsProperty

Nested Class Summary

Method Summary

Method Detail

getAlignment

getBackgroundColor

getBackgroundOpacity

getFont

getFontColor

getFontOpacity

getFontResolution

getFontSize

getOutlineColor

getOutlineSize

getShadowColor

getShadowOpacity

getShadowXOffset

getShadowYOffset

getTeletextGridControl

getXPosition

getYPosition

builder